https://github.com/praisetompane/app_django_quickstart

Facade to reduce Django command ceremony typing.
https://github.com/praisetompane/app_django_quickstart

django

Last synced: 18 days ago
JSON representation

Facade to reduce Django command ceremony typing.

• Host: GitHub
• URL: https://github.com/praisetompane/app_django_quickstart
• Owner: praisetompane
• License: mit
• Created: 2024-12-19T20:38:37.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-03-13T16:40:42.000Z (about 2 months ago)
• Last Synced: 2025-03-13T17:50:40.796Z (about 2 months ago)
• Topics: django
• Language: Python
• Homepage:
• Size: 375 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# app_django_quickstart

## Objectives

- Facade to reduce Django command ceremony typing.

- In-line Django notes for quick reference.

## Project Structure

## Dependencies

- [Django](https://www.djangoproject.com)

## Setup Instructions

- Install [Docker](https://docs.docker.com/get-started/)

- The repository is configured to use [devcontainers](https://containers.dev) for development.

    - [Developing inside a Container](https://code.visualstudio.com/docs/devcontainers/containers)

## Usage

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

- Create project

    ```shell

    ./create_project.sh my_project

    ```

- Create app(s)

    ```shell

    cd my_project

    ```

    ```shell

    ./create_app.sh my_app

    ```

- Apply all migrations to the project

    ```shell

    python manage.py migrate

    ```

- Project state after this

![start system output](./docs/directory_tree.png)

- Run Program

    ```shell

    ./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: 


![start system output](./docs/user_added_comments.png)

## 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.

        ```shell

        # 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/