cynthiaechen / colossal-koalas

Moodlet

A platform for mood-tracking, microjournaling, self-reflection, and mindfulness.

Team

Cynthia Chen @cynthiaechen

Laura Knight @ljknight

Cameron Martin @camhux

Michael Sova @red-starter

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Gulp Scripts

Usage

To run the server in production mode, first install the production dependencies: npm install -p

Then, the server can be started with npm start. Two additional environment variables must be set for the server to run. Set DATABASE_URL to the proper database for your Postgres/MySQL server, and set TOKEN_SECRET to some string you'd like used to create JWTs for session authentication.

Requirements

Server:

• Node >0.12.0
• Express >4.0.0
• Sequelize >2.0.0

Client:

• Angular (with ui-router)
• D3

Development

Installing Dependencies

From within the root directory: npm install

Gulp Scripts

Several useful developer scripts are configured in gulpfile.js. You must configure a .env.json for most of these to work, however, which will contain the same environment variables required for the server to run normally. See example.env.json for a template.

gulp style will run jscs (if you have it installed) and attempt to fix all style errors automatically. Errors that it can't fix automatically will be displayed.

gulp start will run the local server in production mode without you needing to manually set the environment variables.

gulp dev-start will run the local server in test mode (which connects to a separate, always-wiped-clean database schema), with nodemon instead of node to watch for changes.

gulp test will start the server in test mode, run server/spec/spec.js against the server's API endpoints, then stop the server.

gulp db-test will start just the database interface in test mode (which connects to the same separate, always-clean schema as before), and then run server/database/spec/spec.js against the Sequelize interface to the database.

gulp db-reset will start the database interface in reset mode, which will drop all tables in the live schema, not the test schema and then exit the process. Use this should you ever need to fix the tables of your database's main schema.

Roadmap

View the project roadmap here