diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d4614f --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# FitNut-V2 + +This project is a fitness application that uses Java programming language, Android Studio as the development environment, Google's MLKit for accurate pose detection, Firebase for backend services, and Google API Auth for authentication. + +## Requirements + +- Java Development Kit (JDK) +- Android Studio +- Android device with camera support +- Google Cloud Console account for using MLKit APIs +- Firebase project for backend services + +## Installation + +- Clone or download the repository. +- Set up your Google Cloud Console account and create a new project. +- Enable the MLKit APIs in your Google Cloud Console project. +- Obtain the MLKit API key. +- Set up your Firebase project for backend services and obtain the Firebase configuration. +- Set up the Android development environment with Java and Android Studio. +- Connect your Android device to your machine. +- Open the project in Android Studio. +- Add the MLKit API key and Firebase configuration to the project. +- Run the application on your device. + +## Features + +- Accurately detects and counts reps during workouts using Google's MLKit pose detection. +- Assigns a score based on performance. +- Integrates Firebase for backend services, including user authentication and data storage. +- Uses Google API Auth for user authentication. + +## Usage + +- Open the application on your device. +- Log in or create an account using Google API Auth. +- Select a workout from the list. +- Follow the on-screen instructions to complete the workout. +- The application will accurately detect and count your reps and assign a score based on your performance. +- The data will be stored in Firebase for further analysis and leaderboard updates. + +## Contributing + +This project was created by [Aadhithya D](https://github.com/Aadhithya-D), [Steve Aldrin](https://github.com/steve-aldrin). If you would like to contribute to this project, feel free to fork the repository and submit a pull request.