Skip to content

bmukesh23/Edutrack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

67 Commits
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŽ“ 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: Make sure to install Node.js, which includes npm (Node Package Manager).
  • PostgreSQL: Database used to store application data.
  • Docker: Optional tool to containerize and run the backend.

Steps

  1. Clone the repository:

    git clone https://github.com/bmukesh23/Edutrack.git
  2. Navigate to the project directory:

    cd Edutrack
  3. Install Dependencies:

    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:
    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:
    DATASOURCE_URL=
    DATASOURCE_USERNAME=
    DATASOURCE_PASSWORD=
    JWT_SECRET=
    YOUTUBE_API_KEY=
    GOOGLE_API_KEY=
  5. Run the application:

    cd client
    npm run dev
    cd server
    ./mvnw spring-boot:run
  6. Access the App:


๐Ÿณ Running backend with Docker

  1. Build the Docker image:

    docker build -t edutrack .
  2. Run the container:

    docker run -p 8080:8080 --env-file .env edutrack

About

๐ŸŽ“ AI-based LMS platform built with React.TS, Spring Boot, and Gemini.

Topics

Resources

Stars

Watchers

Forks

Languages