BrainFlex is a data-driven tutoring app built specifically for university students to connect with tutors and offer tutoring themselves. Our mission is to make learning more personalized, intuitive, and enjoyable.
By matching students and tutors based on factors like course needs, learning styles, and personality traits, BrainFlex goes beyond traditional tutoring platforms to offer an engaging and effective educational experience.
🎓 Students
👩🏫 Tutor
🛠️ System Administrators
🎓 Academic Advisors
Flask – for building a robust REST API
REST API – to handle and deliver our data
Streamlit – for an interactive and responsive UI
Mockaroo – to generate realistic sample data
-
Clone the repository
-
Configure your environment
- Use the .env.template file to create a new .env file with your unique password
-
Install Docker Desktop (if you haven't already)
-
Start the app
-
docker compose up -din terminal to start -
docker compose downin terminal to shut it down
-
-
Access the app UI
- Open your browser and go to: http://localhost:8501
-
Test API endpoints
- localhost:4000/
route/name
- localhost:4000/