Skip to content

BloomTech-Labs/Workout-Builder-fe

Repository files navigation

Workout Builder

Maintainability Test Coverage

Front end deployed to AWS

You can find the deployed project at www.strongerfaster.fit

Contributors

Jonathan Picazo

David Delfaus

Nadeem Anvaritafti

Burl Fernandes

Nikolai Gaivoronski

Project Overview

This is a workout builder for the professional trainer or highly trained individual that likes to build complex programming of sets, tempos, super sets, failure sets, and all sorts of variations. This products UX should outshine other existing products' interactions and interface.

Key Features

  • Build a library of exericses.
  • Build a library of programs. A program is a collection of workouts.
  • Build workouts. A workout is a collection of exercises to be done on a particular day.
  • Assign a program to a client.
  • Simple and intuitive UI to create exercises/programs/workouts

Tech Stack

Front end built using:

React Redux Reach Router Tailwind

Why we chose these frameworks?

  • Popularity
  • Familiarity
  • State management is built for large applications
  • Tailwind has easy to follow documentation and can be implemented alongside native CSS; makes it easier to add styling within the JSX; less of a learning curve

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

  • REACT_APP_BACKEND_URL - this is the base URL for the backend. It can be set to localhost if running the backend for testing & debugging
  • REACT_APP_SENTRY_DSN - this sets the location to report any errors that occur in the code while the React app is running

Testing

Used Jest & Testing-Library for testing the frontend code.

Installation Instructions

Download or clone the repository on your computer and then run "yarn install" in the terminal window. To start the React App type in "yarn start" & ENTER in the terminal window.

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 Backend Documentation for details on the backend of our project.

About

No description or website provided.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 9