README.md

Bartleby

This README outlines the details of our work on Bartleby, an Ember - Electron desktop application for note taking, with built in markdown editing functionality, and the ability to publish notes as a Gist.

Prerequisites

You will need the following things properly installed on your computer.

• Git
• Node.js (with NPM)
• Bower
• Ember CLI
• PhantomJS

Installation

• git clone <repository-url> this repository
• change into the new directory
• npm install
• bower install

Running / Development

• ember server
• Visit your app at http://localhost:4200.

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

• ember test
• ember test --server

Building

• ember build (development)
• ember build --environment production (production)

Deploying

Specify what it takes to deploy your app.

Further Reading / Useful Links

• ember.js
• ember-cli
• Development Browser Extensions
  • ember inspector for chrome
  • ember inspector for firefox

Usage

• Users can create, read, edit, and delete notes.
• Users are also able to login via simple OAuth.
• Users can live preview the rendered HTML as you write Markdown
• Users can also publish their notes as a gist linked with their GitHub account
• All files are saved to the User's filesystem