Contributors

James Morris(TL)	Nathaniel Buckingham	Kristi Gribble	Jessica Lam	Giovani Garfias	Leza Jackson

API Documentation

Backend deployed at Heroku

Getting started

To get the server running locally:

• Clone this repo
• npm install to install all required dependencies
• npm server to start the local server
• npm test to start server using testing environment

Knex, Express.js, Node.js

• Knex: A query builder for PostgreSQL, because it is designed to be flexible, portable, and fun to use
• Express.js: Released as free and open-source software under the MIT License. It is designed for building web applications and APIs. It has been called the de facto standard server framework for Node.js
• Node.js: An open-source, cross-platform, JavaScript runtime environment that executes JavaScript code outside of a browser.

Endpoints

All endpoints start with /api

User Routes

Method	Endpoint	Access Control	Description
GET	/users/org	users	Returns info for all users.
GET	/users/:userId	users	Returns info for a single user.
POST	/login	users	Logs that user in.
POST	/register	none	Creates a new user.
PUT	/users	users	Updates the current user.
DELETE	/users	users	Deletes the current user.

Workout Routes

Method	Endpoint	Access Control	Description
GET	/workouts/public	users	Gets all public workouts for any logged in user
GET	/workouts	users	Gets all workouts for the logged in user
POST	/workouts	users	Adds workout to currently logged in user
PUT	/workouts/:id	users	Edits a workout that said user owns with given id
DELETE	/workouts/:id	users	Deletes a workout that said user owns with given id

Diet/Food Entry Routes

Method	Endpoint	Access Control	Description
GET	/diets/public	users	Gets all public food entries -Note: all default to true
GET	/diets	users	Gets all food entries for the logged in user
GET	/diets/:id	users	Gets a food entry with the specified id number
POST	/diets	users	Adds a food entry to currently logged in user
PUT	/diets/:id	users	Edits a food entry with the specified id number
DELETE	/diets/:id	users	Deletes a food entry with the specified id number

Meal Plan Routes

Method	Endpoint	Access Control	Description
GET	/mealplan	users	Gets all meal plans for logged in user
GET	/mealplan/:id	users	Gets meal plan with id for logged in user
POST	/mealplan	users	Adds a meal plan to currently logged in user
POST	/mealplan/:id	users	Adds food entry to given meal plan with given id
PUT	/mealplan/:id	users	Updates a meal plan with the given id
DELETE	/mealplan/:id	users	Deletes a meal plan with the given id
DELETE	/mealplan/:id	users	Deletes a food entry from a meal plan id

Routine/Connector Routes

Method	Endpoint	Access Control	Description
GET	/routines	users	Gets all routines for logged in user
GET	/routines/:id	users	Gets routine of id for logged in user
POST	/routines	users	Adds routine to currently logged in user
POST	/routines/:id	users	Adds workout to given routine of given id
PUT	/routines/:id	users	Edits a routine with given id
DELETE	/routines/:id	users	Deletes a routine with given id
DELETE	/routines/:id	users	Deletes a refrence to a workout id with routine id

Following

Method	Endpoint	Access Control	Description
POST	/follow/:id	users	Adds the id give to logged in user follow list
DELETE	/follow/:id	users	Removes the id given from logged in user follow list
GET	/follow/following/:id	any	Gets the list of people following said user
GET	/follow/following/number:id	any	Gets the count of people following said user
GET	/follow/followers	any	Gets the list of people said user follows
GET	/follow/followers/number/:id	any	Gets the count of people said user follows

Likes

Method	Endpoint	Access Control	Description
POST	/likes/:id	users	Posts a like for the given entity id
GET	/likes/post/:id	any	Gets all users who liked given entity id
GET	/likes/user/:id	any	Gets all likes for specified user
DELETE	/likes/:id	users	Removes a like for the given entity id

Comments

Method	Endpoint	Access Control	Description
POST	/comments/:id	users	Posts a comment for the given entity id
GET	/comments/get/:id	any	Gets all comments under given entity_id
GET	/comments/user/:id	any	Gets all comments for given user
DELETE	/comments/:id	users	Removes a comment for the given entity id

Feeds

Method	Endpoint	Access Control	Description
GET	/feed	any	Gets all sharable entities

Data Model

USERS

---

{
  id:
  username:
  email:
  password:
  bio:
  zip:
  affiliate:
  verified:
  xp:
  weight:
  height:
  image:
}

Workouts

---

  {
    workout_category:
    workout_title:
    workout_date:
    workout_start_time:
    workout_end_time:
    workout_description:
    workout_share:
    completed:
    user_id:
  }

Diet/Food

---

  {
    meal_date: string
    meal_time: string
    meal_category: string
    food_name: string
    food_quantity: decimal
    food_measure: string
    food_calories: decimal
    food_fat: decimal
    food_protein: decimal
    food_carbs: decimal
    food_fiber: decimal
    meal_notes: text
  }

Meal Plan

  {
    mealplan_title: string
    user_id: integer
  }

Routine

---

  {
    routine_title: 
    user_id: 
  }

Connector

---

  {
    routines_id:
    workout_id:
  }

Actions

getUsers() -> Returns all users.

getUserById(userId) -> Returns a single user by user ID.

returning(['id', 'email', 'username']) --> Creates a new user and returns that user.

findBy(req.params.id, updatedUser) -> Updates a single user by ID.

deleteUser(userId) -> Deletes everything dependent on the user.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables.

create a .env file that includes the following:

*JWT_SECRET=

*JWT_PUBLIC=

*DB_ENV= *DB_USER=

*DB_LOCALPASSWORD= *DB_HOST= *DB_PORT= *DB_DATABASE=

*DB_NAME= *DB_HOST= *DB_PORT= *DB_USER= *DB_PASSWORD= *DB_SSLMODE= *DB_URL=

*DB_DATABASE_URL=

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

• See Web Frontend Documentation for details on the fronend of our project.
• See iOS App Documentation for details on the iOS portion of our project.
• See UX Documentation for details on the UX design of our project.