Skip to content

BloomTech-Labs/workout-tracker-fe-pt

Repository files navigation

Workout Tracker

You can find the deployed project at https://labspt7-workout-tracker.herokuapp.com/.

Contributors

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


MIT React code style: prettier

Maintainability

Test Coverage

Project Overview

Trello Board

Product Canvas

UX Design files

Empowering users to take control of their workout schedules by planning and managing their routines and tracking key features such as performance and body composition.

Key Features

  • User Onboarding
  • Manage Schedule
  • Manage Daily Workout

Tech Stack

Front end built using:

  • React.js

  • Context API

  • Styled-Components

Front end deployed to heroku

Back end built using:

Knex, Express.js, Node.js

  • Model schema creation
  • Table migrations
  • Connection pooling and seeding

APIs

Authentication API

wger - Workout Manager API

https://wger.de/en/exercise/muscle/overview/

We are using this API so our users can select workouts and plan their daily workout routines. Free and open source, and it provides a lot of data for us.

Environment Variables

*  REACT_APP_DOMAIN = workouttracker.auth0.com
*  REACT_APP_CLIENT_ID = GQ67toqqYZMdF52d3L4gxHH2Vg2M8MH6

Testing

Jest / React Test

Jest manages metadata about your source code so it can learn how to run only the relevant test files when a source code file is changed. Jest's interactive watch mode will show you if you're filtering for any file types.

Installation Instructions

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

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

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