Cardio Tracker App

Table of Contents

• Description
• Installation
• Usage
• Documentation
• Contributing
• License

Description

A cardio tracker app built with Java for Android devices. The app helps users track their cardio exercises and monitor their progress.

Installation

To use the Cardio Tracker app, follow these steps to install it on your Android device:

1. Clone the repository to your local machine using the following command:

git clone https://github.com/Sk-Azraf-Sami/Cardio-Tracker.git

2. Open the project in Android Studio by selecting "Open an Existing Project" and navigating to the cloned repository.

3. Connect your Android device to your computer using a USB cable.

4. Enable USB debugging on your Android device. Go to "Settings" > "Developer options" > "USB debugging" and toggle it on.

5. Build and run the app from Android Studio. Select your connected device from the available devices and click on the "Run" button.

6. The app will be installed and launched on your Android device. You can now start using the Cardio Tracker app to track your cardio activities.

Note: If you don't have a physical Android device, you can also use an Android emulator provided by Android Studio to run the app.

For detailed instructions on setting up an Android emulator and running the app, refer to the Android Emulator Documentation.

Usage

Apps.Video.mp4

To use the Cardio Tracker app, follow these steps:

1. Sign Up:

   • Launch the app and click on the "Sign Up" button.
   • Enter your email address and password to create a new account.
   • Click on the "Sign Up" button to register your account.
   • Upon successful registration, you will be redirected to the login page.

2. Login:

   • Enter your registered email address and password.
   • Click on the "Login" button to authenticate.
   • Upon successful login, you will be directed to the main dashboard.

3. Add a New Record:

   • On the dashboard, click on the "Add New Record" button.
   • Fill in the required information for the record, such as heart rate, systolic pressure, diastolic pressure, and any additional comments.
   • Click on the "Save" button to add the record to your history.

4. View Previous Records:

   • On the dashboard, you can see a list of your previous records.
   • Each record displays information such as heart rate, blood pressure, and comments.
   • Scroll through the list to view all your records.

5. Edit a Record:

   • To edit a record, locate the specific record you want to modify in the list.
   • Click on the "Edit" button or tap on the record to access the edit screen.
   • Update the necessary information.
   • Click on the "Save" button to apply the changes.

6. Delete a Record:

   • To delete a record, locate the specific record you want to remove in the list.
   • Click on the "Delete" button or swipe left on the record.
   • Confirm the deletion when prompted.

Documentation

For detailed information about the Cardio Tracker app, please refer to the Wiki section.

Contributing

Thank you for your interest in contributing to the Cardio Tracker app! We welcome contributions from everyone. To get started, please follow the guidelines below:

Bug Reports and Feature Requests

If you encounter any bugs or have ideas for new features, please open an issue on the GitHub repository. When opening an issue, provide as much detail as possible, including steps to reproduce the issue and any relevant information about your environment. This will help us investigate and address the problem more effectively.

Pull Requests

We gladly accept pull requests for bug fixes, enhancements, and new features. To contribute code to the project, follow these steps:

1. Fork the repository and create your branch from the main branch.
2. Make your changes, ensuring that your code adheres to the project's coding style and conventions.
3. Write tests to cover your changes and ensure the existing tests pass.
4. Ensure your code compiles without any errors or warnings.
5. Commit your changes and push your branch to your forked repository.
6. Open a pull request against the main branch of the original repository.
7. Provide a clear and descriptive title for your pull request and explain the changes you have made.
8. Be responsive to any feedback or questions during the review process.

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Code Style and Conventions

To maintain consistency throughout the project's codebase, please adhere to the following guidelines:

• Use proper indentation and formatting.
• Follow naming conventions for variables, classes, and methods.
• Write clear and concise comments to improve code readability.
• Ensure your code is modular, reusable, and follows best practices.

Communication

If you have any questions or need assistance, feel free to reach out to the project maintainers or open an issue on GitHub.

We appreciate your contributions and look forward to working with you to improve the Cardio Tracker app!

License

This project is licensed under the MIT License.