Skip to content

canafaraci/studybuddyfrontend

Repository files navigation

StudyBuddy

An AI-powered study assistant that helps students learn more effectively through intelligent course management and interactive learning.

Features

  • 📚 Course Management - Create and organize multiple courses
  • 📄 PDF Upload - Upload course materials and slides
  • 🎥 Video Integration - Add lecture recordings with timestamps
  • 💬 AI Chat Assistant - Ask questions and get instant answers
  • 🌓 Dark/Light Mode - Comfortable viewing in any environment
  • 📱 Responsive Design - Works on desktop and mobile

Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn

Frontend Setup

  1. Install dependencies:
npm install
  1. Create a .env file based on .env.example:
cp .env.example .env
  1. Start the development server:
npm run dev

The app will be available at http://localhost:5173/

Backend Setup

  1. Navigate to the server directory:
cd server
  1. Install dependencies:
npm install
  1. Create uploads directory:
mkdir uploads
  1. Start the server:
npm run dev

The API will be available at http://localhost:3001/

Project Structure

├── src/
│   ├── components/      # Reusable UI components
│   ├── screens/         # Main application screens
│   ├── hooks/           # Custom React hooks
│   ├── services/        # API services
│   ├── constants/       # App constants
│   └── types/           # TypeScript types
├── server/              # Backend API
└── public/              # Static assets

API Endpoints

  • POST /api/chat - Send messages to AI assistant
  • POST /api/materials/upload - Upload course materials
  • POST /api/courses/generate-content - Generate course structure from materials

Building for Production

npm run build

License

MIT

About

front edd

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published