/rafikimaths

Friendly Math Exercises

Primary LanguageJavaScriptOtherNOASSERTION

Rafiki Maths

Rafiki Maths is a web application designed to help children from Pre-K to 6th grade practice simple mathematics. Parents can select their child's education level and math topic, providing tailored exercises to help them improve their math skills.

The app is simple, intuitive, and can be easily hosted on GitHub Pages for convenient access.

Features

  • Education Level Selection: Choose from Pre-K to 6th grade.
  • Math Topic Selection: Options include Addition, Subtraction, Multiplication, and Division.
  • Tailored Exercises: Exercises are generated based on the selected level and topic.
  • Real-time Feedback: Receive immediate feedback on correct and incorrect answers.
  • Progress Tracking: A progress bar helps track the child's completion of exercises.

How to Use

  1. Select Education Level:

    • Use the dropdown menu to choose your child's education level, such as Pre-K or 1st Grade.

  2. Select Math Topic:

    • After selecting the education level, pick a math topic from the dropdown menu, such as Addition or Subtraction.

  3. Answer Exercises:

    • Solve each exercise displayed on the screen by entering your answer and clicking "Submit".
    • Receive instant feedback on your answer and move to the next exercise accordingly.

  4. Track Progress:

    • Monitor your progress with the progress bar at the bottom of the screen.

For Developers

Project Structure

  • index.html: Main HTML file containing the structure of the web app.
  • styles.css: CSS file with styles for the web app.
  • main.js: Primary JavaScript file handling initialization, event listeners, and app logic.
  • exercises.js: JavaScript file generating exercises for different levels and topics.
  • progress.js: JavaScript file managing the progress bar and feedback display.

Development Instructions

  1. Setup:

    • Clone the repository: git clone https://github.com/alainrafiki/rafikimaths.git.
    • Navigate to the project directory: cd rafikimaths.

  2. Local Deployment:

    • Open index.html in a web browser to run the app locally.

  3. GitHub Pages Deployment:

    • Commit and push changes to your repository.
    • Configure GitHub Pages to publish from the main branch and / (root) directory.

  4. Adding Features:

    • Define new exercise functions in exercises.js.
    • Update main.js to include the new functions in exercise generation logic.

  5. UI Enhancement:

    • Modify styles.css or add new styles to improve the user experience.

  6. Future Development:

    • Consider adding user authentication or a reward system.
    • Expand the app to include other subjects using the modular structure.

Contribution Guidelines

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-name.
  3. Commit changes: git commit -m 'Add new feature'.
  4. Push branch: git push origin feature-name.
  5. Submit a pull request.

License

See the LICENSE file for details.

Contact

If you have questions or suggestions, open an issue or contact me at Rafiki Technology.

Enjoy using Rafiki Maths!