Giter Club home page Giter Club logo

formfit's Introduction

FormFit

GitHub top language GitHub language count GitHub closed pull requests GitHub repo size

Introduction

FormFit is a digital fitness coach that analyses your form in real-time, assessing alignment and range of motion while exercising. The app gives you a score on squats, push-ups, or sit-ups. The feedback provided is based on calculations of different joints as you exercise. Summary statistics for each repetition are displayed upon completion of a session. Your history will be preserved to view during later visits and your performance data will displayed on the home dashboard in a visually pleasing display. If you are persistent enough, you might find yourself on the global leaderboard, which shows the top 10 point-earners throughout the app!

Video Demonstration


Watch Video

Visit the Deployed App

FormFit This Progressive-Web-App can be used in-browser on a phone or desktop, however it is recommended you use your phone. The app can be installed on the desktop of your phone by following the below instructions:

iOS Installation

  1. Navigate to formfit.herokuapp.com in Safari
  2. Click on the share button shareButton
  3. Select "Add to Home Screen" addToHomeScreen
  4. The FormFit app should now be on your phone's desktop!

Android Installation

  1. Navigate to formfit.herokuapp.com in Chrome image
  2. The first time you visit the site, a prompt will appear offering to install the app on your home screen image
  3. In subsequent visits the prompt may not appear, so you can click on the three dots in the upper right hand corner of Chrome
  4. Tap install app

image

  1. The FormFit app should now be on your phone's desktop!

Tech Stack

The framework of our Progressive Web App relies on React, Redux Toolkit, PostgreSQL, Express, and Node.js, but we also make use of a few other technologies, including:

  • MoveNet from Tensorflow, which uses a trained Machine Learning model to keep track of your body movements in real time, and thus allows us to calculate a score and provide feedback on your form
  • a Redis cache, which sits in front of our database and houses a sorted set that allows our leaderboard to update instantly
  • Material UI, which we used to style our app, and allows it to work well and look great on all devices, though we do recommend using it on your mobile phone

Screen Shot 2021-07-19 at 6 43 54 PM

Setting it Up

  1. Fork and clone this repo.
  2. Install Redis if you haven't already.
  3. npm install.
  4. Create formfit database.
  5. Seed the database with npm run seed.
  6. Instantiate local Redis server with: redis-server.
  7. Start the build process and your application with: npm run start:dev.
  8. Navigate to localhost:8080 to see FormFit in action!

Developers Behind FormFit

RoadMap

While the initial developers of FormFit don't have any plans to further the app, the code was left in a state so future developers can add exercises! Take a look at the Criteria and Pose models in /server/db/models to see how to format any additional criteria and corresponding exercises. Testing the exercise with MoveNet and interpreting the results will be necessary in order to determine what instructions to provide the user. Additionally, some work could also be done to preload the MoveNet model to make for a better user experience. Or, if you have any other ideas, let us know -- we look forward to seeing what can be done with FormFit!

Special Thanks

We would like to initially thank Jason Mayes from TensorFlow for suggesting MoveNet for FormFit and providing us with helpful resources. Additionally, FormFit would not have been possible if it weren't for our two great Team Leads: Lindsay Welhoelter and Ivan Lozano. Also, a special thanks to our Project Manager, Gary Kertis who always asked the tough questions! And of course, thank you to Fullstack Academy for providing us the opportunity to bring FormFit to life!

formfit's People

Contributors

samhannan47 avatar finleymatthews96 avatar alafiand avatar glim2 avatar ericpkatz avatar tstrat avatar sarahzhao25 avatar mmac1020 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.