Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 1.23 KB

File metadata and controls

86 lines (55 loc) · 1.23 KB

Installation Manual - School Secretary

This guide provides step-by-step instructions for installing and running the School Secretary system.

Using Docker (Recommended)

Prerequisites

  • Docker
  • Docker Compose

Instructions

  1. Generate and, preferably, edit the .env files:

    ./controller.sh genenvs
  2. Initialize the project using the controller.sh (uses docker internally):

    ./controller.sh start
  3. Create an administrator user:

    ./controller.sh createsuperuser

Now you can access the site at: http://localhost:8080.

Locally (Manual)

Prerequisites

  • Python
  • Node
  • uv

API

  1. Install the dependencies:

    uv sync
  2. Create the migrations:

    uv run python manage.py makemigrations
  3. Update the database:

    uv run python manage.py migrate
  4. Initialize:

    uv run python manage.py runserver

APP

  1. Go to the app/:

    cd app/
  2. Install the dependencies:

    npm install
  3. Run in development mode:

    npm run dev