/ambits

Mobile-first web application for habit tracking and location-based accountability

Primary LanguageJavaScriptMIT LicenseMIT

Ambitually (formerly Ambits)

Mobile-first web application for habit tracking and location-based accountability

Bet on Tomrrow, Today!

Table of Contents

  1. Team
  2. Usage
  3. Requirements
  4. Development
  5. Contributing

Team

  • Greenfield: Efe Surekli, George Michel, Robert Littlejohn, Ryan Choi
  • Brownfield: -- Team 1 TBD -- Team 2 TBD

Usage

To start the app locally, simply install the npm dependencies and run the server:

npm install
npm start

Requirements

  • MongoDB
  • Express
  • React
  • Node
  • Material-UI
  • Webpack
  • Heroku (for deployment)

Development

Deployment Setup

  1. Set up an account on MongoLab
  2. Set up a Heroku account
  3. Create a MongoLab database for the app
  4. Set a user and password for the MongoLab database

Lastly, make sure to set the following environment variable on Heroku, using heroku set:config KEY=VALUE from the command-line:

  • MONGOLAB_URL = Your MongoLab URL, with db user/pass
  • NPM_CONFIG_PRODUCTION = false, so that Heroku postinstall can run the deployment Webpack build
  • NODE_ENV = 'production', if not set already

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.