Syllabud is an intelligent course generation platform that creates personalized learning paths based on your learning style and preferences. Powered by Google's Gemini AI, it generates comprehensive courses tailored to how you learn best. Learn What Matters.

• Personalized Learning Profiles - Select your learning style (Visual, Auditory, Read/Write, Kinesthetic) and describe your preferences
• AI-Generated Courses - Get custom course content with prerequisites, curriculum, and curated resources
• Depth Control - Choose course complexity from beginner (1) to expert (10)
• User Accounts - Secure authentication with course history saved to your profile
• Adaptive Resources - Resource recommendations tailored to your learning style

Frontend

• React 19
• Vite
• React Router
• Styled Components

Backend

• FastAPI (Python)
• SQLAlchemy + SQLite
• JWT Authentication
• Google Gemini AI

• Node.js 18+
• Python 3.11+
• Google Gemini API Key (Get one here)

1. Clone the repository

   git clone <repository-url>
   cd Syllabud

2. Set up the backend

   cd BackEnd
   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -r requirements.txt

3. Configure environment variables

   Create BackEnd/.env:

   GEMINI_API_KEY=your-api-key-here
   

4. Set up the frontend

   cd FrontEnd
   npm install

1. Start the backend (from BackEnd/ directory)

   uvicorn main:backendApp --reload --port 8000

2. Start the frontend (from FrontEnd/ directory)

   npm run dev

3. Open the app

   Navigate to http://localhost:5173

1. Create an account - Register with username, email, and password
2. Set preferences - Choose your learning style and describe how you learn best
3. Create a course - Enter a topic and select depth level
4. Learn - View your personalized course with curated resources

Syllabud/
├── BackEnd/
│   ├── main.py              # FastAPI application
│   ├── database.py          # SQLAlchemy setup
│   ├── models.py            # Database models
│   ├── auth.py              # Authentication utilities
│   ├── routes/
│   │   ├── auth_routes.py   # Auth endpoints
│   │   └── course_routes.py # Course CRUD + Gemini integration
│   └── .env                 # Environment variables (create this)
├── FrontEnd/
│   ├── src/
│   │   ├── pages/           # Page components
│   │   ├── components/      # Reusable components
│   │   └── contexts/        # React contexts
│   └── package.json
└── TextFiles/
    └── structure.txt        # Course template

• POST /auth/register - Create account
• POST /auth/login - Get access token
• GET /auth/me - Get current user
• PUT /auth/preferences - Update learning preferences

• POST /courses - Generate new course
• GET /courses - List user's courses
• GET /courses/{id} - Get course details
• DELETE /courses/{id} - Delete course

MIT