waffle-iron / memowise

Memowise

Memowise is an awesome flash card app!

Team

• Product Owner: Alex Wong
• Scrum Master: Matt Vargeson
• Development Team Members: Peter Chim, David Valles

Table of Contents

1. Getting Started
2. Requirements
3. Development
   1. Installing Dependencies
   2. Load Sample Data
   3. Tasks
4. Team
5. Contributing

Getting Started

Install Dependencies

From within the root directory:

npm install

Build

This builds the production version to dist/.

Specify your environment variables for the appropriate scripts in package.json.

$ npm run build

Run

$ npm run server-prod

Open application to the host you specified in package.json.

Requirements

• Node 0.10.x
• Redis 2.6.x
• Postgresql 9.1.x
• etc
• etc

Development

Installing Dependencies

From within the root directory:

npm install

Load Sample Data

From within the root directory:

npm run import math.md

Deck file (math.md) MUST be within documentation/decks/ directory

npm run import:all

Import all decks in document/decks/ directory, be careful, it still imports if deck already exists in database.

Tasks

build

$ npm run build

Builds the entire application to dist/. See package.json to set environment variables.

server-prod

$ npm run server-prod

Starts the server in production mode. See package.json to set environment variables.

watch-server

$ npm run watch-server 

Builds and watches server files for changes. Builds to dev/.

watch-client

$ npm run watch-client

Builds and watches client files for changes. Builds to dev/.

run server (development)

$ npm run server-dev

Starts the server in development mode (runs from localhost:3000).

test

$ npm run test

Runs unit tests and coverage report. Ensure mongod and the application is built and the server is running.

coverage

$ npm run coverage

Opens code coverage report in browser.

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.