/OpenHIIT

:weight_lifting: :medal_sports: Open-source, cross platform HIIT and Tabata interval timer. Pull requests are appreciated!

Primary LanguageDartMIT LicenseMIT

OpenHIIT

Integration Tests Release Build

Welcome to OpenHIIT, an open-source workout interval timer mobile application developed using Flutter. This README file provides an overview of the application, its features, installation instructions, and other important information for beta testing.

The timer package is being developed here.

Table of Contents

  1. Introduction
  2. Features
  3. Installation
  4. Usage
  5. Support
  6. Contributing
  7. License

Introduction

OpenHIIT is a fully open source mobile application designed to assist users in their workout routines by providing customizable interval timers. It aims to help users maintain an efficient workout pace by setting intervals for exercise and rest periods.

Features

  • Customizable Timers: Create and customize interval timers according to your workout requirements.
  • Multiple Intervals: Set multiple exercise and rest intervals in a single timer session.
  • Visual and Audio Cues: Get visual and audio cues to indicate the start and end of each interval.
  • Save and Load: Save your favorite interval timer configurations and load them for future use.

Installation

To install and test OpenHIIT, follow these steps:

  1. Ensure you have Flutter and Dart SDK installed on your development environment. For more information, refer to the official Flutter documentation: Flutter Installation

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

    git clone https://github.com/a-mabe/openhiit.git

  3. Change your working directory to the cloned repository:

    cd openhiit

  4. Fetch the dependencies by running the following command:

    flutter pub get

  5. Connect your mobile device or start an emulator.

  6. Launch the application using the following command:

    flutter run

The application will be installed on your device/emulator.

Usage

Once OpenHIIT is installed and running on your device, follow these instructions to use the app:

  1. Launch the app and create a new interval timer.

  2. Customize the exercise and rest intervals according to your workout routine.

  3. Save the timer configuration.

  4. Start the timer and follow the visual and audio cues for exercise and rest intervals.

  5. Customize or load different timer configurations as needed.

  6. Provide feedback and report any bugs or issues you encounter during the beta testing phase.

Support

For support and troubleshooting, please visit the support page.

Contributing

Contributions to OpenHIIT are welcome. If you'd like to contribute, please follow these guidelines:

  1. Fork the repository on GitHub.

  2. Create a new branch with a descriptive name for your feature or bug fix.

  3. Make your changes and ensure they follow the project's coding style and guidelines.

  4. Commit your changes and push them to your forked repository.

  5. Submit a pull request, detailing the changes you made and explaining their purpose.

License

OpenHIIT is open-source software released under the MIT License. You are free to modify and distribute the application under the terms of this license. See the LICENSE file for more information.

Please note that this README file is subject to change as the application evolves. Refer to the latest version of this file in the repository for the most up-to-date information.