The hear-mate is a cross platform software tool designed to assess hearing capabilities. It provides an easy-to-use interface for conducting hearing tests and analyzing results. The app aims to assist individuals in detecting potential hearing issues by playing specific sound frequencies and recording user responses.

The app is dedicated for Sony WH-1000XM5 headphones for results closest to professional. The software was specifically calibrated for this model.

• Flutter
• Python 3.x

1. Clone the repository:

   git clone https://github.com/HearMate/hear-mate-app.git
   cd hear-mate-app

2. Run the application:

   flutter run

3. Choose you platform when prompted

We welcome contributions from the community! To contribute to this project, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine:

   git clone https://github.com/your-username/repo.git
   cd repo

3. Install pre-commit hook on your local machine:

   pip install pre-commit
   pre-commit install

4. Create a new branch for your feature or bugfix:

   git checkout -b feature-or-bugfix-name

5. Make your changes and commit them with a clear message:

   git commit -m "Description of the changes"

6. Push your changes to your forked repository:

   git push origin feature-or-bugfix-name

7. Create a pull request on the original repository and describe your changes.

• Use the GitHub Issues section to report bugs or suggest improvements.

This project is licensed under the MIT License.

• @Michał-Tarnowski
• @Wojciech-Trapkowski
• @Dawid-Glazik
• @Stanisław-Grochowski