README.md

app_django_quickstart

Objectives

• Facade to reduce Django command ceremony typing.
• In-line Django notes for quick reference.

Project Structure

Dependencies

• Django

Setup Instructions

• Install Docker
• The repository is configured to use devcontainers for development.
  • Developing inside a Container

Usage

NB: substitute "my_project" and "my_app" with your actual names.

• Create project

  ./create_project.sh my_project

• Create app(s)

  cd my_project

  ./create_app.sh my_app

• Apply all migrations to the project

  python manage.py migrate

• Project state after this

• Run Program

  ./start_system_development.sh

Django Explanation

The my_project project and my_app app have comments with prefix 'user added:'.
These comments explain how everything fits together.
Search for these in explorer.
example:

Git Conventions

• NB: the master is locked and all changes must come through a Pull Request.
• commit messages:
  • provide concise commit messages that describe what you have done.

    # example:
    git commit -m "feat(core): algorithm" -m"implement my new shiny faster algorithm"

  • screen shot of Githb view
  • references:
    • https://www.conventionalcommits.org/en/v1.0.0/
    • https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/