2. Getting Started

Getting Started

Quick Setup

1. Prerequisite

Ensure Python 3.10 and Git are installed.

2. Installation

# Clone repository
git clone https://github.com/mulearn/mulearnbackend.git
cd mulearnbackend

# Setup Virtual Environment
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Install Dependencies
pip install -r requirements.txt

3. Configuration

Copy the sample environment file and update it with your credentials (database, etc.).

cp .env.sample .env

Important

Database Setup: The database schema and scripts are managed in the db-scripts repository. Please follow the setup instructions there before running the backend.

4. Run Server

python manage.py runserver

The API will be live at http://localhost:8000/.