Skip to content

Latest commit

 

History

History
126 lines (80 loc) · 4.3 KB

README.md

File metadata and controls

126 lines (80 loc) · 4.3 KB

OpenMath-Web-App

OpenMath Logo

Welcome to OpenMath-Web-App - a web application combined with the power of LLMs designed to provide students and learners with a personalized and engaging mathematical learning experience.

ezgif-2-3b39128422

Table of Contents

About OpenMath

OpenMath-Web-App is an AI-powered learning tool designed to democratize math education and literacy by offering personalized learning experiences. Our web application leverages Large Language Models (LLMs) to adapt mathematical explanations, problems, and concepts to the age, interests, and learning styles of students. This approach increases motivation by relating math topics to students' interests and helps reduce math anxiety by adapting to individual learning paces and styles.

Features

  • Personalized Learning Paths: Tailored content based on user interests and learning styles.
  • Interactive Explanations: Engage with math through dynamic and interactive content.
  • Progress Tracking: Monitor your learning journey with detailed progress reports.
  • Accessible Anywhere: Use OpenMath on any device with internet access.

Installation

To get started with OpenMath-Web-App, follow these steps:

  1. Clone the Repository

    git clone https://github.com/yourusername/OpenMath-Web-App.git
    cd OpenMath-Web-App
  2. Install Dependencies

    In your virtual environment:

    pip install -r requirements
    
  3. Set the environemnt variable 'GROQ_API_KEY':

    For this you will need to get your own api key from the groq platform and export it in the following way:

    export GROQ_API_KEY='YOUR_API_KEY'
    
  4. Run the Application

    python web-app/app.py
  5. Open Your Browser

    Navigate to http://localhost:5000 to see OpenMath-Web-App in action.

Usage

  1. Register an Account: Sign up with your personal information to tailor your learning experience.
  2. Set Your Preferences: Customize your profile with your interests and learning preferences.
  3. Start Learning: Dive into a wide range of math topics with personalized explanations and exercises.
  4. Track Your Progress: Use the progress tracking feature to monitor your learning journey.

Screenshots

Home Page Home Page to register and login

Profile Section Profile Section where users set up their likes and preferences

Learning Page Collection of topics that the users can choose to start learning

Contributing

We welcome contributions from the community! If you would like to contribute to OpenMath-Web-App, please follow these steps:

  1. Fork the Repository

  2. Create a Branch

    git checkout -b feature/YourFeature
  3. Commit Your Changes

    git commit -m "Add Your Feature"
  4. Push to the Branch

    git push origin feature/YourFeature
  5. Create a Pull Request

Contact

For any inquiries, suggestions, or feedback, please reach out to us at:

Feel free to explore, learn, and contribute to making math education more personalized and engaging for everyone with OpenMath-Web-App!