Edge

Abstract

1. Introduction

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

2. Objective

A Django project skeleton that is modern and cutting edge.

This project demonstrates how HTML, Python, Django can be applied to a real-world Full Stack Web Development problem.

3. Key Features / Modules

• 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

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• A modern web browser
• VS Code or any code editor
• Python 3.8 or later
• pip / virtualenv for dependencies
• VS Code, PyCharm or Jupyter Notebook
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/arocks/edge.git
cd edge

1. $ python -m venv ./myenv
2. $ source ./myenv/bin/activate.fish (use the appropriate activate script based on your shell)
3. $ python -m pip install -U pip django
4. $ django-admin.py startproject --template=https://github.com/arocks/edge/archive/master.zip --extension=py,md,html,env my_proj
5. $ cd my_proj
6. $ pip install -r requirements.txt
7. $ cd src
8. $ cp my_proj/settings/local.sample.env my_proj/settings/local.env

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add role-based access control
• Deploy on a VPS or cPanel hosting with a custom domain
• Add automated tests and a CI pipeline

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Explain the frontend, backend and database layers of this application.
2. How is user authentication and authorisation implemented?
3. Describe the main database tables / collections and their relationships.
4. Which REST APIs or routes are exposed and what do they return?
5. How would you deploy this application to production?

9. Source Code & License

This project is developed by arocks and published on GitHub under the MIT License. Please follow the license terms and credit the original author when you use or modify this code.