Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jefftriplett/django-startproject
:checkered_flag: Django Start Project template with batteries
https://github.com/jefftriplett/django-startproject
django project startproject
Last synced: 5 days ago
JSON representation
:checkered_flag: Django Start Project template with batteries
- Host: GitHub
- URL: https://github.com/jefftriplett/django-startproject
- Owner: jefftriplett
- License: bsd-3-clause
- Created: 2018-02-10T15:38:30.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T20:05:43.000Z (5 months ago)
- Last Synced: 2024-09-08T18:55:58.975Z (5 months ago)
- Topics: django, project, startproject
- Language: Just
- Homepage:
- Size: 274 KB
- Stars: 176
- Watchers: 11
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-django - django-startproject - Django start project template with batteries. (Projects / Boilerplate)
README
Welcome to django-startproject 👋
> Django startproject template with batteries
## :triangular_flag_on_post: Core Features
- Django 5.1
- Python 3.13
- Docker Compose
- Justfile recipes
- Postgres auto updates
- uv support
## :triangular_flag_on_post: Django Features
- django-click
- environs[django]
- psycopg[binary]
- whitenoise
## :shirt: Linting/auto-formatting
- djade
- django-upgrade
- djhtml
- pre-commit
- pyupgrade
- ruff
### :green_heart: CI
- django-test-plus
- model-bakery
- pytest
- pytest-cov
- pytest-django
### 🏠 [Homepage](https://github.com/jefftriplett/django-startproject)
## :wrench: Install
```shell
$ uv run --with=django django-admin startproject \
--extension=ini,py,toml,yaml,yml \
--template=https://github.com/jefftriplett/django-startproject/archive/main.zip \
example_project
$ cd example_project
$ just bootstrap
```
## :rocket: Usage
```shell
# Bootstrap our project
$ just bootstrap
# Build our Docker Image
$ just build
# Run Migrations
$ just manage migrate
# Create a Superuser in Django
$ just manage createsuperuser
# Run Django on http://localhost:8000/
$ just up
# Run Django in background mode
$ just start
# Stop all running containers
$ just down
# Open a bash shell/console
$ just console
# Run Tests
$ just test
# Lint the project / run pre-commit by hand
$ just lint
# Re-build PIP requirements
$ just lock
```
## `just` Commands
```shell
$ just --list
```
```
Available recipes:
bootstrap *ARGS
build *ARGS
console
down *ARGS
lint *ARGS
lock *ARGS
logs *ARGS
manage *ARGS
pg_dump file='db.dump' # dump database to file
pg_restore file='db.dump' # restore database dump from file
restart *ARGS
run *ARGS
start *ARGS="--detach"
stop *ARGS
tail
test *ARGS
up *ARGS
upgrade
```
## Author
👤 **Jeff Triplett**
* Website: https://jefftriplett.com
* Micro Blog: https://micro.webology.dev
* Mastodon: [@[email protected]](https://mastodon.social/@webology)
* Xwitter: [@webology](https://twitter.com/webology)
* GitHub: [@jefftriplett](https://github.com/jefftriplett)
* Hire me: [revsys](https://www.revsys.com)
## 🌟 Community Projects
* [Django News Newsletter](https://django-news.com)
* [Django News Jobs](https://jobs.django-news.com)
* [Django Packages](https://djangopackages.org)
* [DjangoCon US](https://djangocon.us)
* [Awesome Django](https://awesomedjango.org)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/jefftriplett/django-startproject/issues).
## Show your support
Give a ⭐️ if this project helped you!