https://github.com/bmukesh23/edutrack
🎓 AI-based LMS platform. [Under Work]
https://github.com/bmukesh23/edutrack
axios firebase-auth flask gemini-2-0-flash jwt pymongo python3 react tailwindcss typescript
Last synced: 3 months ago
JSON representation
🎓 AI-based LMS platform. [Under Work]
- Host: GitHub
- URL: https://github.com/bmukesh23/edutrack
- Owner: bmukesh23
- Created: 2024-10-20T17:10:25.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-17T14:25:54.000Z (over 1 year ago)
- Last Synced: 2025-02-17T14:32:37.043Z (over 1 year ago)
- Topics: axios, firebase-auth, flask, gemini-2-0-flash, jwt, pymongo, python3, react, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://edutrack-ai.vercel.app
- Size: 34.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎓 Edutrack
An AI-based Learning Management System (LMS) that adapts to each user’s skill level and learning pace, ensuring a customized and effective learning experience. Built with React.ts, Spring Boot and Gemini Flash 2.5.
## 📦 Technologies
- `React`
- `Typescript`
- `Tailwind CSS`
- `Spring Boot`
- `PostgreSQL`
- `Docker`
## ✨ Features
- **AI-Generated Learning Paths:** Based on initial assessments to personalize learning.
- **Personalized Topic Recommendations:** Focus on strengthening weak areas.
- **Ask AI Feature:** Get instant answers to coding & learning queries.
- **Real-Time Progress Tracking:** Monitor performance with detailed analytics.
- **User Authentication:** Users can securely sign in and access notes with Firebase Auth integrated with JWT.
## 🚦Running the project
### Prerequisites
Before you begin, ensure you have the following installed on your machine:
- [Node.js](https://nodejs.org/): Make sure to install Node.js, which includes npm (Node Package Manager).
- [PostgreSQL](https://www.postgresql.org/): Database used to store application data.
- [Docker](https://www.docker.com/): Optional tool to containerize and run the backend.
### Steps
1. **Clone the repository:**
```bash
git clone https://github.com/bmukesh23/Edutrack.git
```
2. **Navigate to the project directory:**
```bash
cd Edutrack
```
3. **Install Dependencies:**
```bash
cd client
npm install
```
4. **Set Environment Variables:**
1. Create a `.env` file in the root of the `client` folder of the project.
2. Add the following environment variables and replace the values with your own:
```env
VITE_FB_API_KEY=
VITE_FB_AUTH=
VITE_FB_PROJECT=
VITE_FB_STORAGE=
VITE_FB_MESSAGING=
VITE_FB_APP=
VITE_FB_MEASUREMENT=
VITE_BACKEND_URL=
```
1. Create a `.env` file in the `server` folder.
2. Add the following environment variables and replace the values with your own:
```env
DATASOURCE_URL=
DATASOURCE_USERNAME=
DATASOURCE_PASSWORD=
JWT_SECRET=
YOUTUBE_API_KEY=
GOOGLE_API_KEY=
```
5. **Run the application:**
```bash
cd client
npm run dev
```
```bash
cd server
./mvnw spring-boot:run
```
6. **Access the App:**
- By default, the frontend will be available at [http://localhost:5173](http://localhost:5173) and Backend will be available at [http://localhost:8080](http://localhost:8080)
- Once both servers are running:
Open your web browser and go to [http://localhost:5173](http://localhost:5173) and Ensure the backend is accessible.
---
## 🐳 Running backend with Docker
1. Build the Docker image:
```bash
docker build -t edutrack .
```
2. Run the container:
```bash
docker run -p 8080:8080 --env-file .env edutrack
```
---