Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kylase/django-starter-template
Django Starter Template
https://github.com/kylase/django-starter-template
django
Last synced: 4 days ago
JSON representation
Django Starter Template
- Host: GitHub
- URL: https://github.com/kylase/django-starter-template
- Owner: kylase
- License: mit
- Created: 2019-06-13T06:41:52.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-03T21:58:28.000Z (almost 2 years ago)
- Last Synced: 2024-11-01T07:42:49.589Z (about 2 months ago)
- Topics: django
- Language: Python
- Size: 106 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Starter Template
![Django CI](https://github.com/kylase/django-starter-template/actions/workflows/django.yml/badge.svg)
This is a simple template for quick kickstart of Django projects. The dependencies required in this template are:
1. `pytest`, `pytest-django`, `pytest-cov` for testing
1. `django-extensions` and `ipython` for enhanced shell
1. `django-debug-toolbar`for debugging# Quick Start (Development)
1. Clone the project using `git clone`.
1. Rename the top-level `django-starter-template` if you have not clone it as `` and directory `project` to your project name ``
1. In `settings.py`, change the value of `ROOT_URLCONF` to `.urls`
1. In `settings.py`, change the value of `WSGI_APPLICATION` to `.wsgi.application`
1. Create an environment variable named `SECRET_KEY`
1. Create an environment variable named `ENV` to `dev` if for development purpose
1. In `pytest.ini`, change `DJANGO_SETTINGS_MODULE` to `.settings`. Optionally, you can set `DJANGO_SETTINGS_MODULE` as an environment variable that points to your `settings` e.g. `.settings`.
1. Rename `CustomUser` in `common/models.py` to `` as this is the [recommended](https://docs.djangoproject.com/en/2.2/topics/auth/customizing/#using-a-custom-user-model-when-starting-a-project) way to extend the default `User` class in the future.
1. Run `pip install -r requirements/dev.txt` to install third-party dependencies# Guide
- `requirements/dev.txt` is for development packages
- `requirements/test.txt` is for testing packages
- `requirements/prod.txt` is for production packages