WordFlow

WordFlow is a text editor with accountability. Instead of just telling writers how many words they've written, it measures the consistency of their typing, and generates a score based on their output. It encourages writers to keep writing by sharing their consistency with other users in real-time, and it helps build good habits by analyzing and keeping track of day-to-day writing output.

Team

• Product Owner: Bahia ElSharkawy
• Scrum Master: Peter Espe
• Development Team Members: JD Davis

Table of Contents

1. Development
   1. Installing Dependencies
   2. Server Environment Setup
   3. Client Environment Setup
   4. Tasks
2. Team

Development

Installing Dependencies

npm install

NPM should install bower dependencies automatically.

Server Environment Setup

Description

Follow these instructions to get Postgres up and running for the development and testing environments.

Install Postgres

• Install the Postgres app from http://postgresapp.com/
  • Next, follow these instructions to set up your bash profile $PATH
• Run the Postgres app from your Applications folder

Install Sequelize-CLI

• npm install -g sequelize-cli

Initial Setup

• Clone the repo

• cd impromptu-sunset

• npm install

• grunt setup —user YOUR_MAC_USERNAME

• grunt nodemon

• be sure to change YOUR_MAC_USERNAME to your actual Mac username

Client Environment Setup

Description

Follow these instructions if you want Karma to re-run the tests automatically on a file change.

Install the Karma Command Line Tool

npm install -g karma-cli

Start Karma

karma start

Run Tests

To run the tests after installing, simply type grunt test into the command line from the root directly.

Updating Database migrations

Check sequelize-cli for information on how to create migrations.

Deploying to Heroku

• grunt deploy --prod (push to heroku)

• grunt heroku-setup (runs migrations on heroku)

Code Documentation

Documented Client Code here Documented Server Code here