{"id":15017468,"url":"https://github.com/fueled/django-init","last_synced_at":"2025-04-07T13:09:05.816Z","repository":{"id":14651785,"uuid":"17369900","full_name":"Fueled/django-init","owner":"Fueled","description":"Project template used at Fueled for scaffolding new Django based projects. :dizzy:","archived":false,"fork":false,"pushed_at":"2023-12-20T15:58:11.000Z","size":2061,"stargazers_count":187,"open_issues_count":17,"forks_count":48,"subscribers_count":28,"default_branch":"main","last_synced_at":"2024-04-14T04:02:34.119Z","etag":null,"topics":["ansible","aws","boilerplate","cookiecutter","cookiecutter-template","django","django-environ","django-rest-framework","hacktoberfest","letsencrypt","mkdocs","python","python3","ubuntu","uwsgi"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Fueled.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-03-03T15:19:26.000Z","updated_at":"2024-07-24T05:44:45.602Z","dependencies_parsed_at":"2024-07-24T05:54:57.122Z","dependency_job_id":null,"html_url":"https://github.com/Fueled/django-init","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fueled%2Fdjango-init","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fueled%2Fdjango-init/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fueled%2Fdjango-init/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fueled%2Fdjango-init/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Fueled","download_url":"https://codeload.github.com/Fueled/django-init/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657281,"owners_count":20974345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible","aws","boilerplate","cookiecutter","cookiecutter-template","django","django-environ","django-rest-framework","hacktoberfest","letsencrypt","mkdocs","python","python3","ubuntu","uwsgi"],"created_at":"2024-09-24T19:50:31.216Z","updated_at":"2025-04-07T13:09:05.799Z","avatar_url":"https://github.com/Fueled.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/Fueled/django-init/master/.github/django-init-logo.png\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cstrong\u003edjango-init\u003c/strong\u003e is a project boilerplate for Django based projects.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://travis-ci.com/Fueled/django-init\"\u003e\u003cimg src=\"https://travis-ci.com/Fueled/django-init.svg?branch=master\" alt='Build Status'\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n- Django 4.1.x\n- Python 3.9.x\n- [Poetry][poetry] Support\n- Support for [black](https://pypi.org/project/black/)!\n- [12-Factor][12factor] based settings management via [django-environ], reads settings from `.env` if present.\n- Supports PostreSQL 13.0 (support of postgis-3.0 is available).\n- [Django Rest Framework][drf] 3.13.x.\n- Uses `django_sites` instead of `django.contrib.sites`.\n- Uses [mkdocs] for project documentation. Optionally, password protect the docs when deployed via Ansible\n- Uses [pytest] as test runner.\n- Github Actions\n- Custom `User` app, for easier extensibility.\n- Custom `Auth` app with JWT based Token Backend system with `login`, `logout` and `current_user_profile` modification views for easier extensibility.\n- robots.txt and humans.txt configured.\n\n### Optional\n- Heroku Setup\n- Fly Setup\n- Ubuntu 20 LTS via [Ansible]\n- Celery with flower integration.\n- AWS S3 media storage\n- [Letsencrypt](https://letsencrypt.org/) Support via [certbot](https://certbot.eff.org).\n- Postgis Setup\n- Newrelic\n- Sentry\n- [GraphQL](https://graphql.org/) support via [Graphene-Django](https://docs.graphene-python.org/projects/django/en/latest/) (Optional)\n- pre-commit hooks\n\n\n## Getting Started\n\nInstall cookiecutter with `brew install cookiecutter` or `pip install cookiecutter`.\n\n```\ncookiecutter gh:Fueled/django-init\n```\n\nIt 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.\n\nIf you opt to setup the project automatically, it will also:\n- initialize a git repo and bump initial tag and version.\n- create a virtualenv in the folder `venv` inside the project.\n- install all the python dependencies inside it.\n- create `poetry.lock` file after resolving dependencies and then generate `requirements.txt` and `requirements_dev.txt` for production and dev use respectively, for backward-compatibility.\n- create a postgres database and run the initial migration against it.\n\nthen only thing you'll need to do is:\n\n1. `cd` into the new `github_repository` folder just created.\n2. Run `make run` or activate virtualenv with `poetry shell` and run `./manage.py runserver`\n\nDon't forget to carefully look at the generated README. Awesome, right?\n\nYou can also explore the [wiki] section for details on advance setup and usages.\n\n## Managing dependencies\n\n### Poetry\n\nTo guarantee repeatable installations, all project dependencies are managed using [Poetry](https://python-poetry.org/). The project’s direct dependencies are listed in `pyproject.toml`.\nRunning `poetry lock` generates `poetry.lock` which has all versions pinned.\n\nYou can install Poetry by using `pip install --pre poetry` or by following the official installation guide [here](https://github.com/python-poetry/poetry#installation).\n\n*Tip:* We recommend that you use this workflow and keep `pyproject.toml` as well as `poetry.lock` under version control to make sure all computers and environments run exactly the same code.\n\n### Other tools\n\nFor compatibility, `requirements.txt` and `requirements_dev.txt` can be updated by running\n\n```bash\npoetry export -f requirements.txt -o requirements.txt\npoetry export -f requirements.txt -o requirements_dev.txt --with dev\n```\n\nor\n\n```bash\nmake generate_requirements\n```\n\n## Articles\n\n- [Setting up Django projects in a breeze](https://medium.com/fueled-engineering/setting-up-django-projects-in-a-breeze-36c715cc9a6f)\n\n## Release Policy\n\n`django-init` is a rolling release project. Commit and fixes are added to `master` branch on regular basis and always have latest stable django and associated libraries. You are advised to follow-up with changelogs.\n\n## Changelogs\n\nRefer to [HISTORY.md](HISTORY.md).\n\n## Code of Conduct\n\nEveryone interacting in the django-init project's codebase, issue trackers, chat rooms, and mailing lists is expected to follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).\n\n## Related Projects\n\n- https://github.com/pydanny/cookiecutter-django\n- https://github.com/wemake-services/wemake-django-template\n- https://github.com/lionheart/django-template\n\n--------\n\nBuilt with ♥ at [Fueled](https://fueled.com)\n\n[wiki]: https://github.com/Fueled/django-init/wiki\n[poetry]: https://python-poetry.org/docs/\n[mkdocs]: http://www.mkdocs.org/\n[12factor]: http://12factor.net\n[pytest]: http://pytest.org/\n[django-environ]: https://github.com/joke2k/django-environ\n[Ansible]: http://docs.ansible.com/index.html\n[drf]: http://www.django-rest-framework.org/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffueled%2Fdjango-init","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffueled%2Fdjango-init","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffueled%2Fdjango-init/lists"}