boot-sandre/django-spaninja

Django api server with single page app template

Django api server + single page app template

• Api server using Django Ninja
• Vitejs frontend using Vuejs

Features

• Auth and csrf protected api by default
• Auto generated api docs
• Django forms support
• Login and logout
• User registration with email confimation
• Responsive frontend with dark mode support

📚 Read the documentation

• Get started
  • Install and run
  • Write endpoints
  • Build
• 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