FitomoUserGeneration

Getting started
Clone the latest version
Install dependencies
Define Enviormental Variables
Run the application
Tech Stack
Directory Layout
Contributing
License

What it looks like

What it does

Creates mock user data for Fitbit and Jawbone Up daily activities. Scales user activity by introducing intesity variable which dictates range of activity for that user.

Getting started

1. Clone the latest version

Start by cloning the latest version of the Fitomo/Fitomo-User-Generation and on your local machine by running:

$ git clone https://github.com/Fitomo/Fitomo-User-Generation.git
$ cd Fitomo-User-Generation

2. Install Dependencies

From within the root directory run the following command to install all dependencies:

$ npm install

3. Define Environmental Variables

Define the environmental variable IP to equal the host of the server.

4. Run the application

$ npm start

Access the application at the host's port 4000

Tech Stack

Front End:

React

Back End:

Node
Express

Testing:

Mocha
Chai
Travis CI

Directory Layout

├── /client/                    # Client files
│   ├── /components/            # Front-End Dependencies
├── /lib/                       # Compiled Program
├── /node_modules/              # 3rd-party libraries and utilities
├── /server/                    # Server source code
│   ├── /controllers/           # Manage API calls and request handling
│   ├── /generators/            # Generate User Data
│   ├── /routes/                # Handle all routing
│   ├── /server.js              # Core server file
├── /test/                      # Test Setup
├── .eslintrc                   # ESLint settings
├── .babelrc                    # Babel settings
├── .travis.yml                 # TravisCI settings
├── Dockerfile                  # Docker configuration
├── package.json                # List of 3rd party libraries and utilities to be installed

Contributing

Fork the repo.
Clone it to your local computer
Cut a namespaced feature branch from master and name it appropriately
Make commits and prefix each commit with the type of work you were doing
BEFORE PUSHING UP YOUR CHANGES, rebase upstream changes into your branch, fix any potential conflicts, and then push to your fork.
Submit a pull request directly to the master
Someone else will perform code review to keep codebase clean
Fix any errors or issues raised by the reviewer and push the fixes as a single new commit
Repeat until the pull request is merged.

License

M.I.T

shadowfool/FitomoUserGeneration