Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 2.67 KB

README.md

File metadata and controls

84 lines (55 loc) · 2.67 KB

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

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 3
  • Formatted with Black

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

Quick start

Before creating a new project from this template, you need to create a fresh virtual environment and install Django:

  1. $ python -m venv ./myenv

  2. Pick the appropriate activate script based on your OS/shell

    • On Windows: .\myenv\Scripts\activate.bat
    • On Linux/bash: $ source ./myenv/bin/activate
    • On Linux/fish: $ source ./myenv/bin/activate.fish
  3. $ python -m pip install -U pip wheel django

Create your new edgy django project (Replace edgy in all commands to the name of your project):

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

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)
  • users (Custom User model with user profile views)

Installation

Quick start

To set up a development environment quickly, first create a virtual env. Then run these commands:

  1. $ cd {{ project_name }}
  2. $ pip install -r requirements.txt
  3. $ cd src
  4. $ cp edgy/settings/local.sample.env edgy/settings/local.env (alterntively, setup the environment vars)
  5. $ python manage.py migrate
  6. $ python manage.py createsuperuser
  7. $ python manage.py runserver

Open your browser and login using the superuser credentials you used in step 6!

Detailed instructions

Take a look at the docs for more information.