Metronome

A simple and effective metronome application built with Flutter.

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Running Tests
3. Contributing

About The Project

This Metronome app is a mobile application built using Flutter, designed to provide musicians with a simple and reliable tool for time-keeping. It offers adjustable BPM, visual feedback, and clear audio cues for practice sessions.

Key features include:

• Adjustable BPM: Easily set the tempo from 1 to 250 beats per minute using a slider or increment/decrement buttons.
• Play/Pause Control: Start and stop the metronome at any time.
• Visual Beat Indicator: A measure bar visually displays the current beat in a 4-beat measure.
• Accent on First Beat: Option to enable an accented sound for the first beat of each measure.
• Audio Cues: Utilizes distinct sound files for regular and accented ticks.
• Theme Toggle: Switch between light and dark themes for user preference, with the choice persisted across sessions.

(back to top)

Built With

This project is built with Flutter and leverages the following major libraries/frameworks:

• Flutter
• Bloc
• FlutterSoloud
• Hydrated Bloc

(back to top)

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Ensure you have the Flutter SDK installed on your system.

• Flutter SDK v3.29.0 For installation instructions, please refer to the official Flutter documentation.

Installation

1. Clone the repo

   git clone https://github.com/GreatApe77/metronome.git

2. Navigate to the project directory

   cd metronome

3. Install Flutter packages

   flutter pub get

4. Run the app

   flutter run

5. For Android Emulator, ensure you have an emulator running or a device connected.

(back to top)

Running Tests

This project includes unit tests to ensure code quality and functionality. Tests are located in the test directory.

To run the unit tests, use the following command in your terminal from the project's root directory:

flutter test

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)