Bendwell

A wellness platform
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Bendwell is a wellness platform aimed at those who are stuck at their desks for many hours at a time. Through the use of a custom trained pose detection model, users are able to stretch and recieve real time feedback, without having to leave their office, desk, or any other workspace they are at. Users can choose stretches to try from our pre-trained catalogue of stretches, or if interested, can make an account to build custom routines for targeting certain muscle groups, having a set break for stretching, or to accomate for different space requirments.

Built With

Here is a list of the technology and frameworks used to build Bendwell.

• React.js
• Node.js
• Redux
• Supabase
• TensorFlow
• Teachable Machine
• Sass

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/cs-2201-15/capstone

3. Install NPM packages

   npm install

4. Run the application

npm run start

Usage

• To use the app, navigate to the stretches view to read more information about any of the stretches. Press 'try stretch' to run the stretch cam and try out the website's main feature yourself.
• If a user is interested in compiling more than one stretch together into a routine, either create an account or log in. After logging in, the user is able to create a new routine in the routines tab, and add individual stretches into that routine from the stretches tab. To run a routine, select any of the user's routines and press the 'start routine' button to run the stretch cam.
• To remove a stretch, press the 'remove' button in a specific routine, and similarly to remove an entire routine, press 'remove routine' from within the routines tab.
• To edit any information within the user's profile or any of the user-created routines, press the 'edit' button to edit any information availible.

Roadmap

• Add Stretches through Teachable Machine trained model
• Compile stretches into routines for users
• Run stretches from catalogue through pose detection and classification feature - "Stretch Cam"
• Progressive Web App capability
• Incorporate social connections through sharing and rating routines

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

• Ricardo Payares - Github - rpaya03@gmail.com
• Robert Berman - Github - robertberman.tech@gmail.com
• Samuel Joh - Github - samueljoh329@gmail.com
• Alberto Huerta - Github - albertohuerta22@gmail.com

Project Link: https://github.com/cs-2201-15/capstone

(back to top)