Skip to content

introduction

  • Backend : Django ninja

  • Frontend : TypeScript React

Author New Version

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Screenshot

Project layout

.gitignore   # The configuration file.
django/      # backend
react/       # frontend
media/       # media files

django/

    # Django settings.
    mysite/   # The documentation homepage.
        staticfiles/
            __init__.py
            apps.py
        settings.py
        urls.py

    # User Model Customize & Ninja Base API
    core/
        templates/
            base.html
            index.html
        admin.py
        api.py
        models.py
        router.py                
        schema.py
        tests.py
        urls.py
        views.py

    # API contents
    content/   
        router.py                
        schema.py
        admin.py
        models.py
        tests.py
        views.py