An intelligent educational platform with interactive learning paths and AI-powered feedback.

• Java 21 (LTS)
• Spring Boot 3.2.0
• Firebase (Firestore & Authentication)
• Google Cloud Vertex AI (Gemini 1.5)

• React + TypeScript
• React Router
• Firebase SDK

edukit/
├── backend/               # Spring Boot backend
│   ├── src/
│   │   └── main/
│   │       ├── java/com/edukit/
│   │       │   ├── config/       # Configuration classes
│   │       │   ├── controller/   # REST controllers
│   │       │   ├── model/        # Data models
│   │       │   └── service/      # Business logic
│   │       └── resources/
│   │           └── application.yml
│   └── pom.xml
│
├── frontend/              # React frontend (to be implemented)
└── README.md

• Java 21 or higher
• Maven 3.9+
• Node.js 18+ (for frontend)
• Firebase account
• Google Cloud account (for AI features)

1. Clone the repository

   git clone git@github.com:dirgnic/eduKit.git
   cd eduKit

2. Configure Firebase (Optional - can run in mock mode)

   • Place your firebase-credentials.json in the backend/ directory
   • Update backend/src/main/resources/application.yml with your Firebase URL

3. Run the backend

   cd backend
   mvn spring-boot:run

   The backend will start on: http://localhost:8080/api

4. Test the API

   curl http://localhost:8080/api/health

cd frontend
npm install
npm start

✅ RESTful API architecture
✅ User authentication (ready for Firebase)
✅ Course management
✅ Lesson organization
✅ Progress tracking
✅ Assignment submissions
✅ AI-powered suggestions (ready for Vertex AI)
✅ Interactive course maps
✅ Health monitoring endpoints

🚧 React frontend
🚧 Firebase integration
🚧 Google Cloud AI integration

GET /api/health          # Get service status
GET /api/health/ping     # Simple ping

GET    /api/courses      # List all courses
GET    /api/courses/{id} # Get specific course
POST   /api/courses      # Create new course
PUT    /api/courses/{id} # Update course
DELETE /api/courses/{id} # Delete course

• Teachers: Full access to create/edit content and view all student data
• Students: View own progress and assignments

cd backend
mvn spring-boot:run -Dspring-boot.run.arguments="--spring.profiles.active=dev"

cd backend
mvn clean package
java -jar target/edukit-backend-1.0.0.jar

Create a backend/src/main/resources/application-local.yml for local configuration:

firebase:
  credentials-path: ./firebase-credentials.json
  database-url: https://your-project.firebaseio.com

google:
  cloud:
    project-id: your-project-id
    location: us-central1

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

This project is licensed under the MIT License.

EduKit Team

Status: Backend ✅ Running | Frontend 🚧 In Development