Giter VIP home page Giter VIP logo

impromptu-sunset's Introduction

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: Ashwin Aravindan
  • Scrum Master: Niall O'Kane
  • Development Team Members: David Hom

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 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

impromptu-sunset's People

Contributors

ashm-4 avatar bahiafayez avatar dvdhm avatar jdstep avatar nokane avatar plespe avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.