Skip to content

Latest commit

 

History

History
116 lines (89 loc) · 2.29 KB

File metadata and controls

116 lines (89 loc) · 2.29 KB

Setup Guide

Quick Start

Prerequisites

  • Python 3.8+
  • Node.js 18+
  • PostgreSQL
  • Redis (optional, for Celery)

Backend Setup

  1. Navigate to backend:

    cd backend
  2. Create and activate virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
  3. Install dependencies:

    pip install -r requirements.txt
  4. Configure environment:

    cp .env.example .env
    # Edit .env with your database credentials
  5. Run migrations:

    python manage.py makemigrations
    python manage.py migrate
  6. Create superuser:

    python manage.py createsuperuser
    # Or use the sample data command which creates one
  7. Load sample data (optional):

    python manage.py load_sample_data
  8. Run server:

    python manage.py runserver

Frontend Setup

  1. Navigate to frontend:

    cd frontend
  2. Install dependencies:

    npm install
  3. Run development server:

    npm run dev

Access the Application

Default Credentials (after loading sample data)

Troubleshooting

Database Connection Issues

  • Ensure PostgreSQL is running
  • Check database credentials in .env
  • Verify database exists: createdb timetable_db

Frontend Build Issues

  • Clear node_modules and reinstall: rm -rf node_modules && npm install
  • Check Node.js version: node --version (should be 18+)

Import Errors

  • Ensure all dependencies are installed
  • Check Python virtual environment is activated
  • Verify all migrations are applied

Next Steps

  1. Create your first college via Master Admin dashboard
  2. Add departments, teachers, subjects, and sections
  3. Generate your first timetable
  4. Customize the algorithm parameters as needed