Repository files navigation

django-init is a project boilerplate for Django based projects.

• Django 4.1.x
• Python 3.9.x
• Poetry Support
• Support forblack!
• 12-Factor based settings management viadjango-environ, reads settings from.env if present.
• Supports PostreSQL 13.0 (support of postgis-3.0 is available).
• Django Rest Framework 3.13.x.
• Usesdjango_sites instead ofdjango.contrib.sites.
• Usesmkdocs for project documentation. Optionally, password protect the docs when deployed via Ansible
• Usespytest as test runner.
• Github Actions
• CustomUser app, for easier extensibility.
• CustomAuth app with JWT based Token Backend system withlogin,logout andcurrent_user_profile modification views for easier extensibility.
• robots.txt and humans.txt configured.

• Heroku Setup
• Fly Setup
• Ubuntu 20 LTS viaAnsible
• Celery with flower integration.
• AWS S3 media storage
• Letsencrypt Support viacertbot.
• Postgis Setup
• Newrelic
• Sentry
• GraphQL support viaGraphene-Django (Optional)
• pre-commit hooks

Install cookiecutter withbrew install cookiecutter orpip install cookiecutter.

cookiecutter gh:Fueled/django-init

It will ask you couple of questions required to generate the project. It will generate a folder containing all the files in your current working directory.

If you opt to setup the project automatically, it will also:

• initialize a git repo and bump initial tag and version.
• create a virtualenv in the foldervenv inside the project.
• install all the python dependencies inside it.
• createpoetry.lock file after resolving dependencies and then generaterequirements.txt andrequirements_dev.txt for production and dev use respectively, for backward-compatibility.
• create a postgres database and run the initial migration against it.

then only thing you'll need to do is:

1. cd into the newgithub_repository folder just created.
2. Runmake run or activate virtualenv withpoetry shell and run./manage.py runserver

Don't forget to carefully look at the generated README. Awesome, right?

You can also explore thewiki section for details on advance setup and usages.

To guarantee repeatable installations, all project dependencies are managed usingPoetry. The project’s direct dependencies are listed inpyproject.toml.Runningpoetry lock generatespoetry.lock which has all versions pinned.

You can install Poetry by usingpip install --pre poetry or by following the official installation guidehere.

Tip: We recommend that you use this workflow and keeppyproject.toml as well aspoetry.lock under version control to make sure all computers and environments run exactly the same code.

For compatibility,requirements.txt andrequirements_dev.txt can be updated by running

poetryexport -f requirements.txt -o requirements.txtpoetryexport -f requirements.txt -o requirements_dev.txt --with dev

or

make generate_requirements

• Setting up Django projects in a breeze

django-init is a rolling release project. Commit and fixes are added tomaster branch on regular basis and always have latest stable django and associated libraries. You are advised to follow-up with changelogs.

Refer toHISTORY.md.

Everyone interacting in the django-init project's codebase, issue trackers, chat rooms, and mailing lists is expected to follow thePyPA Code of Conduct.

• https://github.com/pydanny/cookiecutter-django
• https://github.com/wemake-services/wemake-django-template
• https://github.com/lionheart/django-template

Built with ♥ atFueled