README_EN.md

ClanEver DRF Template

A simple drf template. Initialize a Django project skipping steps such as rye init and django-admin startproject xxx.

Powered by cookiecutter and rye

Integration

• celery [Doc | Doc With Django]
  • django-celery-beat
  • django-celery-results
  • flower [Doc]
• simpleui [Doc]
• django-import-export [Doc]
• django-structlog [Doc]
  • structlog [Doc]
• django-rest-framework [Doc]
  • dj-rest-auth [Doc]
  • django-rest-knox [Doc]
• drf-spectacular [Doc]

Utility Libraries

• arrow [Doc]
• more-itertools [Doc]
• msgspec [Doc]
• requests [Doc]
• tenacity [Doc]

Usage

1. Install rye

2. Use rye to install cookiecutter

   rye install cookiecutter --extra-requirement jinja2-strcase

3. Use this template

   cookiecutter https://github.com/ClanEver/clanever-drf-template.git

4. Change settings.py then run in dev

   # make migrations and migrate
   rye run dev_mnm
   # runserver
   rye run dev

5. [Optional] Use app template

   rye run startapp
   # or
   cookiecutter https://github.com/ClanEver/clanever-drf-app-template.git

Relation

clanever-drf-app-template

License

MIT