The platform revolutionizes education by using OpenAI Assistants feature. The web application includes interactive lessons, personalized tutoring, and intelligent Q&A. A Python Flask backend manages user data and platform operations in a MongoDB database, while a JavaScript backend interfaces with the OpenAI API for real-time assistant interactions. The platform supports multimedia content uploads, customizable learning paths, and real-time performance analytics, enhancing the learning experience for students and educators alike.
To set up and run SmartLearnAI on your local machine, follow these steps:
1) Install Node.js: Ensure Node.js is installed on your system. If not, download and install it from Node.js official website.
2) Set up the project:
- Create a new npm project in a directory of your choice.
- Clone this GitHub repository.
- Replace the "src" directory of your new npm project with the "src" directory from this repository.
3) Install dependencies: Navigate to the root directory of the project and run npm install to install all required dependencies.
4) Start the application:
- Launch the application with npm start.
- This command will start the JavaScript backend. Ensure the server starts without errors.
5) Configure environment variables:
- Navigate to src/backend and create a .env file if it doesn't exist.
- Add your OpenAI API key to the .env file with the format OPENAI_API_KEY=YOUR_API_KEY_HERE.
6) Run backend servers:
- Execute python flaskServer.py to start the Flask server.
- Ensure both Flask and Node.js servers are running simultaneously.
7) Access the platform:
- Register an account on the platform as either a student or a teacher by following the registration instructions on the welcome page.
- Once registered, log in to explore the educational platform and utilize its features.
For any issues during installation or running the servers, please refer to the troubleshooting section or open an issue on this repository.