{% comment "This comment section will be deleted in the generated project" %}
A Fantastic Django project starter.
- Ready Bootstrap-themed pages
- User Registration/Sign up
- Better Security with 12-Factor recommendations
- Logging/Debugging Helpers
- Works on Python 3 and Django 2
- Formatted with Black
More information at: http://django-edge.readthedocs.org/ Contribute using: Edge Dev Tools ✨ 🍰 ✨
Before creating a new project from this template, you need to create a fresh virtual environment and install Django:
$ python -m venv ./myenv$ source ./myenv/bin/activate.fish(use the appropriate activate script based on your shell)$ python -m pip install -U pip django
Create your new edgy django project:
$ django-admin.py startproject --template=https://github.com/arocks/edge/archive/master.zip --extension=py,md,html,env my_proj$ cd my_proj$ pip install -r requirements.txt$ cd src$ cp my_proj/settings/local.sample.env my_proj/settings/local.env$ python manage.py migrate$ python manage.py createsuperuser$ python manage.py runserver
-
$ pip install --user --upgrade pipenv(Install pipenv system-wide or locally but outside a virtualenv) -
$ mkdir my_proj(choose a better name thanmy_projfor your project) -
$ django-admin.py startproject --template=https://github.com/arocks/edge/archive/master.zip --extension=py,md,html,env my_proj .If you get an SSL error, then download the zip file and mention it after
--template=, like this:django-admin.py startproject --template=~/Downloads/master.zip --extension=py,md,html,env my_proj . -
$ pipenv install --dev -
$ pipenv shell -
$ cp src/my_proj/settings/local.sample.env src/my_proj/settings/local.env(or rename this file) -
$ cd src -
$ python manage.py migrate -
$ python manage.py createsuperuser -
$ python manage.py runserver
If you need to keep requirements.txt updated then run
pipenv lock --requirements > requirements/base.txt
echo "-r base.txt" > requirements/development.txt
pipenv lock --requirements --dev >> requirements/development.txt
Rest of this README will be copied to the generated project.
{% endcomment %}
{{ project_name }} is a short description. It is built with Python using the Django Web Framework.
This project has the following basic apps:
- App1 (short desc)
- App2 (short desc)
- App3 (short desc)
To set up a development environment quickly, first install Python 3. It comes with virtualenv built-in. So create a virtual env by:
1. `$ python3 -m venv {{ project_name }}`
2. `$ . {{ project_name }}/bin/activate`
Install all dependencies:
pip install -r requirements.txt
Run migrations:
python manage.py migrate
Take a look at the docs for more information.