Skip to content

All-Khwarizmi/chut-next

Repository files navigation

Chut - Classroom Noise Management App

Chut is a unique classroom noise management application designed to help teachers maintain an optimal noise level in their classrooms, fostering an environment conducive to learning.

Table of Contents

Features

  • Chut Premium: Provides the ability to upload or record up to 20 custom sounds, enhancing the classroom noise management experience.
  • Real-time Audible Alerts: Notifies students when the noise level exceeds a set limit, promoting self-regulation.
  • Recall Quiz Application: Utilizes spaced repetition for effective memorization, coupled with push notifications for timely quizzes.

Installation

To use Chut, follow these steps:

  1. Clone the repository: git clone https://github.com/yourusername/chut.git
  2. Install dependencies: npm install
  3. Configure settings: Adjust noise levels, alert thresholds, and other configurations in the settings file.

Usage

  • To start the application, run npm start.
  • Access the Chut Premium features through the settings menu in the application interface.
  • For API documentation and additional details, refer to the Wiki.

Contributing

We welcome contributions! To contribute to Chut, follow these steps:

  1. Fork the repository.
  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.

License

This project is licensed under the MIT License. You are free to modify and distribute the project as per the license terms.

Releases

No releases published

Packages

No packages published