AI EduPlatform

An AI-powered educational platform for creating, managing, and transforming learning materials.

---

Table of Contents

1. Project Overview
2. Key Features
3. Getting Started
4. Application Structure
5. Technologies
6. Contributing
7. License
8. Support

---

Project Overview

AI EduPlatform is a comprehensive learning tool that leverages artificial intelligence to help educators and students create, organize, and enhance their educational materials. The platform brings together note-taking, content generation, and multimedia processing to streamline every step of the learning journey.

---

Key Features

📝 Smart Notes System

• Create, edit, and manage notes with rich formatting
• Organize notes with tags and categories
• Set visibility (private, public, or link-only)
• AI-powered note generation and enhancement

🎴 Flashcards

• Convert notes to interactive flashcards
• Study with spaced-repetition scheduling
• Customize categories and difficulty levels

🎓 Educational Content Generation

• Transform notes into structured learning scenarios
• Generate professional presentations from notes
• Produce comprehensive study materials automatically

🎬 Video Transcription

• Convert video lectures to text
• Support multiple video formats
• Edit and save transcriptions as notes

🌐 Web Scraping

• Extract content from educational websites
• Convert scraped content to formatted notes
• Edit and customize imported material

---

Getting Started

Prerequisites

• Node.js (v18 or later)
• MongoDB or Docker
• PNPM package manager

Installation

1. Clone the repository

   git clone https://github.com/TechniCamp/2025
   cd ./2025/

2. Set environment variables

   cp .env.example .env
   # → edit .env with your values

3. Install dependencies

   pnpm install

4. Start the development server

   pnpm dev

   Then open http://localhost:3000 in your browser.

Using Docker (Optional)

1. Ensure Docker and Docker Compose are installed.
2. Run the containers:

   docker compose up --build

3. Visit http://localhost:3000.

---

Application Structure

src/
├─ app/          # Front-end pages & layouts
├─ components/   # Reusable UI components
├─ hooks/        # Custom React hooks
├─ collections/  # Payload CMS collection definitions
└─ services/     # Service integrations (Ollama, etc.)

---

Technologies

• Frontend: Next.js, React, Tailwind CSS
• Backend / CMS: Payload CMS, Node.js
• Database: MongoDB
• AI Integration: Ollama (locally hosted models)
• Containerization: Docker

---