FitAI (Built at HackThisFall)

Get Fit with FitAI: Your Virtual Personal Trainer, powered by AI Technology.

📃Table of contents:

1.	What is FitAI
2.	Problem Statement
3.	The Solution
4.	Our Tech Stack
5.	Contributions
6.	References

💪What is FitAI?

FitAI is a virtual personal trainer that generates personalized exercise and diet plans for its users. The app tracks the user's progress daily, ensuring that they are on track to reach their fitness goals. The app uses AI algorithms to suggest workouts based on the user's current fitness level and progress, ensuring that their exercise regimen is challenging but achievable.

📸 Screenshots

🏋️‍♀️Problem Statement

We live in an era where fitness is more important than ever before. With so many diets and workout routines, it's easy to get overwhelmed and miss out on the benefits of an active lifestyle. Our aim is to change that, by making fitness accessible and convenient for everyone.

🍎The Solution

FitAI is an AI-powered platform that revolutionizes the way we workout. It is designed to cater to your individual needs and provides personalized workout plans based on your fitness goals, schedule and preferences.

🥗Features

1. Transform Your Diet
2. Get Moving
3. Free of cost(Plan Generator)
4. Track Your Progress
5. Expert Support

🤖Our Tech Stack

To begin with, first, we did User Research. Next, we created the user flow and functionality. This led us to high-fidelity design and implementation. Here is our tech stack.

1. Figma for UI designing.
2. Next js for frontend development.
3. Node js for backend development.
4. Appwrite for Authentication purpose.
5. Tailwind for Styling
6. Material UI for UI Components.
7. Alan AI is used for Voice Accessibility.
8. OpenAI Api is used for generating Diets and Exercise Plan.

📚References

• To design the user flow, we have used ExcaliDraw. Here is the link: HTF Project

• For documentation, we have used Notion file.

• To check deployment, visit this link 👉 FitAi

🎥Demo Video

Click Here to watch FitAI Website Demo Video

Installation

This project is built on nextJS 13 experimental version

1. Fork the repo into your account

2. Clone the project into your local machine

git clone https://github.com/<Your-name>/fitAI.git

3. Navigate the folder

cd fitAI

3. Install the dependencies

npm install

4. Make .env file in root directory with these variables

OPEN_API_KEY= 'YOUR OPENAI API KEY GOES HERE'

• Get your openAI api key here: OPENAI API
  
  

NEXT_PUBLIC_ALAN_KEY= 'YOUR ALAN AI API KEY GOES HERE'

• Get your Alan AI api key here: ALANAI API

5. Run the project on local machine

npm run dev

6. Every time you start making changes to your forked repo make sure it's in sync with the original repo

Contributing Guidelines

Thank you for considering to contribute to this project.

What do I need to know to contribute?

This project is in a very early stage so anybody who's familiar with ReactJS/NextJS/Typescript/TailwindCSS can contribute. If you don't feel ready to make a contribution yet, no problem at all. You can also contribute to this ReadMe section or the Documentation part of our project.

If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below.

• ReactJS Official Docs
• NextJS Documentation
• Typescript Documentaion
• TailwindCSS Docs
• Material UI Documentaion

How to make a Contribution?

Never made an open source contribution before? And wondering how to contribute to this project? No worries! Here's a quick guide,

1. Choose any feature/bug you wish to contribute to.
2. Fork the repository into your own account.
3. Clone the repo you have forked in your local machine using git clone https://github.com/<Your-name>/fitAI.git
4. Create a new branch for your fix by using the command git checkout -b YourName-branch-name
5. Make the changes you wish to do and stage them using the command git add files-you-have-changed or use git add .
6. Use the command git commit -m "Short description of the changes" to describe the changes you have done with a message.
7. Push the changes to your remote repository using git push origin your-branch-name
8. Submit a PR(pull request) to the upstream repository Nishantjain10/fitAI with a title and a small description.
9. Wait for the pull request to be reviewed by us.
10. Make appropriate changes if the maintainer recommends you to and submit it.
11. Await for your contribution to be merged into the repository.

Checkout the Contributing.md file before contributing.

License

MIT

Thanks to all the Contributors ❤️

Your Support means a lot

Give a ⭐ to the project if you liked it. :)