Skip to content

Latest commit

 

History

History
115 lines (78 loc) · 2.77 KB

README.md

File metadata and controls

115 lines (78 loc) · 2.77 KB

Fit Together

For those who love to breathe deep, get active, and stay connected, we offer you the experience that is sure to please: Fit Together. Fit Together integrates with your FitBit, your Move devices, or your phone to log real-time responses from your daily fitness regimen. We analyze that data to present personalized suggestions and statistics to help you stay on track with your goals. We also make fitness fun by inviting you to compete with friends, families, and anyone in the world with challenges and character leveling. Are you ready to Fit Together?

Team

Tegan Duong Tegan Duong

Lynn Chen Lynn Chen

AJ Grande AJ Grande

Peter Chim Peter Chim

Table of Contents

  1. Usage
  2. Tech Stack
  3. System Architecture
  4. SQL Database Schema
  5. Development
    1. Installing Dependencies
    2. Setup
    3. Roadmap
  6. Contributing

Usage

Some usage instructions

Tech Stack

  • Node 0.10.x
  • Express
  • Webpack
  • React
  • Redux
  • MongoDB
  • PostgreSQL
  • Redis
  • Passport/OAuth
  • Socket.IO

Webpack needs to be installed globally

sudo npm install -g webpack 

System Architecture

System Architecture

SQL Database Schema

SQL Database Schema

Development

Installing Dependencies

From within the root directory:

Install dependencies:

npm install

Setup

To seed the database with example data:

npm run seed

To build and run:

npm run build
npm start

Running the command may open your browser to localhost:3000, just hit the refresh button once to see the page.

If you want to autoupdate on saved changes made to client files, run in a separate terminal window:

npm run watch-c

You may need to refresh the browser to see it change.

If you want to autoupdate on saved changes made to server files, run in a separate terminal window:

npm run watch-s

Before making any pull requests, be sure to run the command below to make sure all tests are passing.

npm test

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.