{"id":19189864,"url":"https://github.com/vivify-ideas/python-django-drf-boilerplate","last_synced_at":"2025-04-09T23:19:38.161Z","repository":{"id":40520757,"uuid":"207495615","full_name":"Vivify-Ideas/python-django-drf-boilerplate","owner":"Vivify-Ideas","description":"Django Boilerplate for starting fresh new DRF projects","archived":false,"fork":false,"pushed_at":"2024-03-01T11:27:51.000Z","size":134,"stargazers_count":169,"open_issues_count":6,"forks_count":44,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-02T21:09:38.510Z","etag":null,"topics":["boilerplate","django","docker","drf","python","swagger"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Vivify-Ideas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-10T07:42:55.000Z","updated_at":"2025-02-06T07:50:12.000Z","dependencies_parsed_at":"2024-11-09T11:33:00.652Z","dependency_job_id":"76c4da3b-8c94-4e66-88d9-2fd8722c8a5a","html_url":"https://github.com/Vivify-Ideas/python-django-drf-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vivify-Ideas%2Fpython-django-drf-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vivify-Ideas%2Fpython-django-drf-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vivify-Ideas%2Fpython-django-drf-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vivify-Ideas%2Fpython-django-drf-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Vivify-Ideas","download_url":"https://codeload.github.com/Vivify-Ideas/python-django-drf-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248125880,"owners_count":21051818,"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":["boilerplate","django","docker","drf","python","swagger"],"created_at":"2024-11-09T11:31:56.296Z","updated_at":"2025-04-09T23:19:38.139Z","avatar_url":"https://github.com/Vivify-Ideas.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Django Rest Framework boilerplate\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nThis is boilerplate for starting fresh new DRF projects. It's built using [cookiecutter-django-rest](https://github.com/agconti/cookiecutter-django-rest).\n\n## Highlights\n\n- Modern Python development with Python 3.8+\n- Bleeding edge Django 3.1+\n- Fully dockerized, local development via docker-compose.\n- PostgreSQL\n- Full test coverage, continuous integration, and continuous deployment.\n- Celery tasks\n\n### Features built-in\n\n- JSON Web Token authentication using [Simple JWT](https://django-rest-framework-simplejwt.readthedocs.io/en/latest/)\n- Social (FB + G+) signup/sigin\n- API Throttling enabled\n- Password reset endpoints\n- User model with profile picture field using Easy Thumbnails\n- Files management (thumbnails generated automatically for images)\n- Sentry setup\n- Swagger API docs out-of-the-box\n- Code formatter [black](https://black.readthedocs.io/en/stable/)\n- Tests (with mocking and factories) with code-coverage support\n\n## API Docs\n\nAPI documentation is automatically generated using Swagger. You can view documention by visiting this [link](http://localhost:8000/swagger).\n\n## Prerequisites\n\nIf you are familiar with Docker, then you just need [Docker](https://docs.docker.com/docker-for-mac/install/). If you don't want to use Docker, then you just need Python3 and Postgres installed.\n\n## Local Development with Docker\n\nStart the dev server for local development:\n\n```bash\ncp .env.dist .env\ndocker-compose up\n```\n\nRun a command inside the docker container:\n\n```bash\ndocker-compose run --rm web [command]\n```\n\n## Local Development without Docker\n\n### Install\n\n```bash\npython3 -m venv env \u0026\u0026 source env/bin/activate                # activate venv\ncp .env.dist .env                                             # create .env file and fill-in DB info\npip install -r requirements.txt                               # install py requirements\n./manage.py migrate                                           # run migrations\n./manage.py collectstatic --noinput                           # collect static files\nredis-server                                                  # run redis locally for celery\ncelery -A src.config worker --beat --loglevel=debug\n  --pidfile=\"./celerybeat.pid\"\n  --scheduler django_celery_beat.schedulers:DatabaseScheduler # run celery beat and worker\n```\n\n### Run dev server\n\nThis will run server on [http://localhost:8000](http://localhost:8000)\n\n```bash\n./manage.py runserver\n```\n\n### Create superuser\n\nIf you want, you can create initial super-user with next commad:\n\n```bash\n./manage.py createsuperuser\n```\n\n### Running Tests\n\nTo run all tests with code-coverate report, simple run:\n\n```bash\n./manage.py test\n```\n\n\nYou're now ready to ROCK! ✨ 💅 🛳\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvivify-ideas%2Fpython-django-drf-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvivify-ideas%2Fpython-django-drf-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvivify-ideas%2Fpython-django-drf-boilerplate/lists"}