Edge

Overview

EdgeBuild is a Django project starter built with Python and Django Web Framework. It provides Bootstrap-themed pages, user registration/sign up, better security with 12-Factor recommendations, logging/debugging helpers, and works on Python 3 and Django 2. It is also formatted with Black for code consistency.

Features

• Bootstrap-themed pages: Ready-made pages styled with Bootstrap.
• User Registration/Sign up: Includes functionality for user registration and sign up.
• Better Security: Follows 12-Factor recommendations for improved security.
• Logging/Debugging Helpers: Includes tools to assist in debugging and logging.
• Python 3 and Django 2 Support: Compatible with Python 3 and Django 2.
• Formatted with Black: Code formatting for consistency.

Installation

To install the EdgeBuild project, follow these steps:

1. Create a fresh virtual environment and install Django:

   $ python -m venv ./myenv
   $ source ./myenv/bin/activate
   $ python -m pip install -U pip django
   

2. Create your new project using the EdgeBuild template:

   $ 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
   

3. Recommended Installation (with pipenv):

   $ pip install --user --upgrade pipenv
   $ mkdir my_proj
   $ django-admin.py startproject --template=https://github.com/arocks/edge/archive/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 encounter an SSL error, download the zip file and mention it after –template.

   $ django-admin.py startproject --template=~/Downloads/master.zip --extension=py,md,html,env my_proj
   

Summary

EdgeBuild is a Django project starter that offers pre-built features like Bootstrap-themed pages, user registration, better security practices, logging/debugging helpers, Python 3 and Django 2 support, and code formatting with Black. Its installation process involves setting up a virtual environment, installing dependencies, and running migrations to get started with a new Django project. Additional documentation provides detailed instructions for setup and configuration.