https://github.com/cssnr/django5-boiler

Django 5 Boilerplate
https://github.com/cssnr/django5-boiler

Last synced: 11 months ago
JSON representation

Django 5 Boilerplate

• Host: GitHub
• URL: https://github.com/cssnr/django5-boiler
• Owner: cssnr
• Created: 2024-07-31T21:03:33.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2025-04-05T20:23:47.000Z (about 1 year ago)
• Last Synced: 2025-04-05T21:18:50.493Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 176 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![CI](https://img.shields.io/github/actions/workflow/status/cssnr/django5-boiler/ci.yaml?logo=github&label=ci)](https://github.com/cssnr/django5-boiler/actions/workflows/ci.yaml)

[![Lint](https://img.shields.io/github/actions/workflow/status/cssnr/django5-boiler/lint.yaml?logo=github&label=lint)](https://github.com/cssnr/django5-boiler/actions/workflows/lint.yaml)

[![Test](https://img.shields.io/github/actions/workflow/status/cssnr/django5-boiler/test.yaml?logo=github&label=test)](https://github.com/cssnr/django5-boiler/actions/workflows/test.yaml)

[![Codecov](https://codecov.io/gh/cssnr/django5-boiler/graph/badge.svg?token=6YSWJ1E6BJ)](https://codecov.io/gh/cssnr/django5-boiler)

[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/django5-boiler?logo=github&label=updated)](https://github.com/cssnr/django5-boiler/graphs/commit-activity)

[![GitHub Top Language](https://img.shields.io/github/languages/top/cssnr/django5-boiler?logo=htmx&logoColor=white)](https://github.com/cssnr/django5-boiler)

[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=github&label=org%20stars)](https://cssnr.github.io/)

[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)

# Django 5 Boilerplate

My App is Good.

Coming soon...

# Workflows

## GitHub Variables and Secrets

These variables/secrets are used by various workflows...

| name                 | type    | description                                                                      |

| -------------------- | ------- | -------------------------------------------------------------------------------- |

| GHCR_USER            | vars    | GHCR Username                                                                    |

| GHCR_PASS            | secrets | GHCR Password/Token                                                              |

| SERVICE_CONFIGS_KEY  | secrets | SSH Key for [service-configs](https://github.com/hosted-domains/service-configs) |

| PORTAINER_URL        | secrets | Portainer URL                                                                    |

| PORTAINER_TOKEN      | secrets | Portainer Token                                                                  |

| CLOUDFLARE_API_TOKEN | secrets | **Optional** Cloudflare Token                                                    |

## Workflow Variables

These are convoluted because GitHub wanted to block variables to punish us.

| File                                                       | Description                    |

| ---------------------------------------------------------- | ------------------------------ |

| [dev-ci.yaml](.github%2Fworkflows%2Fdev-ci.yaml)           | Defines variables under deploy |

| [dev-deploy.yaml](.github%2Fworkflows%2Fdev-deploy.yaml)   | Repeated variables from above  |

| [prod-deploy.yaml](.github%2Fworkflows%2Fprod-deploy.yaml) | Defines variables under deploy |

# Development

```shell

cp settings.env.example settings.env

vim settings.env

set -a; source settings.env; set +a

npm install

docker compose -f docker-compose-dev.yaml up --build --remove-orphans --force-recreate

```