Перейти до змісту

Довідник CLI: school-admin

school-admin створює каркас сайту, наповнює його демонстраційними даними та перевіряє заповненість частини полів. Юридичну відповідність команда не засвідчує.

📌 Огляд команд

usage: school-admin [-h] {startproject,create-school,check-compliance,seed-data,create-frontend} ...
Команда Опис
startproject Створити новий проєкт сайту школи з попередньо налаштованою структурою
create-school Зареєструвати або оновити реквізити закладу освіти в базі даних
check-compliance Перевірити поля й документи, охоплені реалізованим аудитором
seed-data Додати демонстраційні записи для локального тесту
create-frontend Згенерувати React 19 + Vite фронтенд

1. school-admin startproject

Створює базовий каталог проєкту зі структурою Django. Без додаткового прапорця фронтенд не генерується.

school-admin startproject <project_name> [--output-dir <path>] [--frontend-template {classic,editorial,portal}]

Приклад:

school-admin startproject gymnasium_12

Щоб одразу отримати React-сайт, виберіть макет. Файли з'являться у gymnasium_12/frontend/:

school-admin startproject gymnasium_12 --frontend-template editorial

--output-dir задає батьківську теку Django-проєкту, а --frontend-template створює фронтенд усередині нього. Доступні макети описані в розділі про фронтенд.

2. school-admin create-school

Створює синглтон-запис школи або оновлює його реквізити.

school-admin create-school "<school_name>" [параметри]

Параметри:

  • --edrpou: Код ЄДРПОУ закладу (8 цифр).
  • --short-name: Скорочена назва (наприклад, «Гімназія №1»).
  • --founder: Засновник (орган місцевого самоврядування, громада).
  • --city: Місто або населений пункт.
  • --address: Повна юридична адреса.
  • --capacity: Ліцензована місткість закладу.
  • --actual: Фактична кількість учнів на навчальний рік.
  • --language: Мова освітнього процесу (за замовчуванням «Українська»).
  • --primary-color: Фірмовий колір школи у форматі hex (#1e3a8a).

3. school-admin check-compliance

Перевіряє заповненість реалізованого переліку полів і документів. Перегляньте результат вручну перед публікацією; 100% не означає повної юридичної відповідності.

school-admin check-compliance [--json]

Прапорець --json повертає машинозчитуваний звіт для власних перевірок.

4. school-admin seed-data

Заповнює базу зразками документів, звітів, розкладу та меню. Дані призначені для тесту; перед запуском реального сайту їх потрібно замінити.

school-admin seed-data

5. school-admin create-frontend

Створює SPA на базі React 19 і Vite.

school-admin create-frontend [--output-dir frontend] [--template {classic,editorial,portal}] [--api-url http://127.0.0.1:8000] [--force]

Параметри:

  • --output-dir (або -o): назва папки створюваного фронтенду (за замовчуванням frontend).
  • --template: макет classic, editorial або portal; без прапорця використовується classic.
  • --api-url: адреса Django бекенду для налаштування Vite reverse-proxy (за замовчуванням http://127.0.0.1:8000).
  • --force (або -f): перезаписати файли, якщо директорія вже існує.

Наприклад, якщо Django-проєкт уже створено, у його каталозі виконайте:

school-admin create-frontend --template portal --output-dir frontend
cd frontend
npm install
npm run dev

Параметри --frontend-template і --template доступні у django-school-framework 0.2.7 або новішій. Версію встановленого пакета можна перевірити командою pip show django-school-framework.