https://github.com/aryaappaji/drf-api-kickstart
This is a template repository which helps to kickstart Django Rest Framework(DRF) applications. By including the best packages found in the python and django ecosystem
https://github.com/aryaappaji/drf-api-kickstart
backend backend-api django django-application django-project-setup django-project-template django-rest-framework drf drf-api-template python python-backend python-web-framework python3 web-framework
Last synced: 3 months ago
JSON representation
This is a template repository which helps to kickstart Django Rest Framework(DRF) applications. By including the best packages found in the python and django ecosystem
- Host: GitHub
- URL: https://github.com/aryaappaji/drf-api-kickstart
- Owner: AryaAppaji
- License: other
- Created: 2024-12-11T10:58:24.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-04-28T06:33:42.000Z (5 months ago)
- Last Synced: 2025-04-28T07:33:48.609Z (5 months ago)
- Topics: backend, backend-api, django, django-application, django-project-setup, django-project-template, django-rest-framework, drf, drf-api-template, python, python-backend, python-web-framework, python3, web-framework
- Language: Python
- Homepage:
- Size: 142 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DRF API Kickstart
This repository serves as a template for setting up Django projects quickly and easily. It includes essential configuration and packages to streamline the development of common backend features. Ideal for developers looking for a reliable starting point, this template supports multiple databases, external storage integration, and real-time WebSocket communication.
## Features
- **Multi-Environment Setup**
Pre-configured settings for development, staging, and production environments, allowing you to switch between them effortlessly by adjusting environment variables.
- **Database Support**
Packages included for the following databases:
- MySQL
- PostgreSQL
- MSSQL
- MariaDB
- MongoDB
- OracleDB
- **Django REST Framework (DRF)**
A pre-configured setup for building RESTful APIs using DRF, saving time on setup and integration.
- **Django-Storages Integration**
Seamless integration with `django-storages` for easy communication with external storage systems, such as Amazon S3.
- **WebSocket Support (Channels)**
Real-time communication capabilities through WebSocket support via Django Channels.
- **Pre-built custom-commands for faster development**
`add_model` - Adds the basic sacaffold for given model name to the given app.
`make_custom_command` - Adds the boilerplate to create a custom command.
`make_view` - Adds the boilerplate to create a view file in given app.
`removeapp` - Removes the given app from the project.
`set_secret_key` - Creates the secret key for the selected environment and adds it to the `.env` file.
`setup_crud_view` - Creates a view for the CRUD operations along with their serializers under the given app.
`startapp` - Customized the built-in startapp command to include additional directories and add the newly created app to the settings file.
## How to Setup
To know how to use this template checkout [SETUP.md](SETUP.md)
## Official Package Documentations
For official documentations for the packages included in this template, please checkout the below links.
- [Django Extensions](https://django-extensions.readthedocs.io/en/latest/)
- [Django](https://docs.djangoproject.com/en/5.1/)
- [Django Environ](https://django-environ.readthedocs.io/en/latest/)
- [Django REST Framework](https://www.django-rest-framework.org/)
- [Django Seed](https://github.com/brobin/django-seed)
- [Factory Boy](https://github.com/FactoryBoy/factory_boy)
- [Django Storages](https://django-storages.readthedocs.io/en/latest/)
- [Django Import Export](https://django-import-export.readthedocs.io/en/latest/)
- [DRF Spectacular](https://drf-spectacular.readthedocs.io/en/latest/)
- [Django Redis](https://github.com/jazzband/django-redis)
- [Django Channels](https://channels.readthedocs.io/en/latest/)
- [MySQL Client](https://mysqlclient.readthedocs.io/)
- [Psycopg](https://www.psycopg.org/psycopg3/docs/)
- [Djongo](https://www.djongomapper.com/get-started/)
- [Oracle DB](https://python-oracledb.readthedocs.io/en/latest/)
- [Django MSSQL Backend](https://github.com/ESSolutions/django-mssql-backend)
- [Maria DB](https://mariadb-corporation.github.io/mariadb-connector-python/)
- [Requests](https://requests.readthedocs.io/en/latest/)
- [Ruff](https://docs.astral.sh/ruff/)
- [Jinja2](https://jinja.palletsprojects.com/en/stable/)
- [Pytest Django](https://pytest-django.readthedocs.io/en/latest/)
- [Django Sonar](https://github.com/metalogico/django-sonar)
## Acknowledgments
Parts of this project are inspired by the [HackSoft Styleguide Example](https://github.com/HackSoftware/Django-Styleguide-Example), which is licensed under the MIT License.