Skip to content
A Django project skeleton that is modern and cutting edge.
HTML Python CSS JavaScript
Branch: master
Clone or download
arocks Fix Issue #83
An SSL error occurs for some users especially on macOS. So explicit zip file download step is mentioned in the README.
Latest commit cc8ab41 Feb 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Added docs Aug 30, 2014
logs Added loggers May 10, 2015
requirements Downgraded to 2.0.9 due to travis Nov 7, 2018
src Reformatted all .py files using 'black' formatter Jan 20, 2019
.gitignore
.travis.yml Removed Python 2.x support Mar 27, 2018
LICENSE.txt Initial Aug 30, 2014
Pipfile Updating dependencies Oct 16, 2018
Pipfile.lock Updated Django to 2.1.3 Nov 7, 2018
README.md Fix Issue #83 Feb 7, 2019
requirements.txt Cleanups: unused packages from requrements and alerts from js Feb 16, 2015

README.md

{% comment "This comment section will be deleted in the generated project" %}

Edge

Build Status

A Fantastic Django project starter.

Features

  • 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

Quick start:

  1. $ django-admin.py startproject --template=https://github.com/arocks/edge/archive/master.zip --extension=py,md,html,env my_proj
  2. $ cd my_proj
  3. $ pip install -r requirements.txt
  4. $ cd src
  5. $ cp my_proj/settings/local.sample.env my_proj/settings/local.env
  6. $ python manage.py migrate

More information at: http://django-edge.readthedocs.org/ Contribute using: Edge Dev Tools 🍰

Recommended Installation (with pipenv)

  1. $ pip install --user --upgrade pipenv (Install pipenv system-wide or locally but outside a virtualenv)

  2. $ mkdir my_proj (choose a better name than my_proj for your project)

  3. $ 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 .

  4. $ pipenv install --dev

  5. $ pipenv shell

  6. $ cp src/my_proj/settings/local.sample.env src/my_proj/settings/local.env (or rename this file)

  7. $ cd src

  8. $ python manage.py migrate

  9. $ python manage.py createsuperuser

  10. $ 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 }}

{{ 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)

Installation

Quick start

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

Detailed instructions

Take a look at the docs for more information.

You can’t perform that action at this time.