boot-sandre/skii-school-platform

Planning backend application for skii school with Python/Django/Pydantic/Ninja api

Skii platform

• Api server using Django Ninja
• Vitejs frontend using Vuejs

Features

• User management with profile (student/teacher)
• Planning management with scheduled lesson
• Place/Skii station promote and location
• Lesson level and certification (TODO)

📚 Read the documentation

• Get started
  • Install and run
• Base app
  • Forms
    • Usage
  • Schemas
• Account app
  • Endpoints
  • Schemas
  • Utilities
    • Email
    • Token

Development

Code quality

This project uses Pycheck to monitor the quality of the code. To install the code quality tools:

make install-pycheck
# or
yarn global add @pycheck/cli
yarn global add @pycheck/ui
# or
npm install -g @pycheck/cli
npm install -g @pycheck/ui

Analysis and history

Run:

pycheckui

Open localhost:5143 in a browser to run an analysis. Note: this uses a .pycheck.db local Sqlite file to store the code quality history

Command line

To do a quick check in the command line (not recorded in history):

pycheck
# or
make pycheck

Unittest

To launch full set of project unittest

make test

Install

To install project on a local dev environment

make install
# Also if need to be logged
make superuser

Launch and access

To launch

make run

To access api docs you need to follow http://localhost:8000/skii/docs To access django admin you need to http://localhost:8000/admin/

Enjoy

All skii source code is licensed with mozilla MPL 2 and all new source python file needs to integrate this headers

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
# Copyright © Simon ANDRÉ <simon@emencia.com> synw (https://github.com/synw/)
# project: SkiiSchoolPlatform
# github: https://github.com/boot-sandre/skii-school-platform/
# template: https://github.com/synw/django-spaninja

Enjoy and use it :P