https://github.com/app-generator/sample-django-debug
How to DEBUG Django - Free Sample and DOCS | AppSeed
https://github.com/app-generator/sample-django-debug
appseed-sample debug-django django-debug django-sample django-starter
Last synced: about 1 year ago
JSON representation
How to DEBUG Django - Free Sample and DOCS | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/sample-django-debug
- Owner: app-generator
- License: other
- Created: 2023-04-14T05:22:35.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-10T05:33:08.000Z (about 3 years ago)
- Last Synced: 2025-04-06T18:13:33.835Z (about 1 year ago)
- Topics: appseed-sample, debug-django, django-debug, django-sample, django-starter
- Language: Python
- Homepage: https://docs.appseed.us/technologies/django/how-to-debug/
- Size: 27.3 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [How to DEBUG Django](https://docs.appseed.us/technologies/django/how-to-debug/)
Open-source **Django Dashboard** built on top of a modern design. **[Volt Dashboard](https://appseed.us/product/volt-dashboard/django/)** is a free and open source `Bootstrap 5` Admin Dashboard featuring over 100 components, 11 example pages and 3 plugins with Vanilla JS. There are more than 100 free Bootstrap 5 components included some of them being buttons, alerts, modals, and datepickers.
- 👉 [Volt Dashboard Django](https://appseed.us/product/volt-dashboard/django/) - Product page
- 👉 [Volt Dashboard Django](https://django-volt-dashboard.appseed-srv1.com/) - LIVE Demo
- 🛒 **[Django Volt Dashboard PRO](https://appseed.us/product/volt-dashboard-pro/django/)** - `Premium Version`
> Features:
- ✅ `Up-to-date Dependencies`
- ✅ Theme: [Django Admin Volt](https://github.com/app-generator/django-admin-volt)
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
- 🚀 `Deployment`
- `CI/CD` flow via `Render`
## Manual Build
> 👉 Download the code
```bash
$ git clone https://github.com/app-generator/django-volt-dashboard.git
$ cd django-volt-dashboard
```
> 👉 Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
```
> 👉 Logging
The project integrates logging by default. For this to work, create a file called `apps_home.log` in the `logs` directory. To use the logger, you can do the following 👇
```python
from loggers import apps_home_logger
...
try:
a = 1 / 0
return render(request, "pages/index.html")
except ZeroDivisionError as e:
apps_home_logger.log(CRITICAL, msg=e)
```
> 👉 Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
> 👉 Create the Superuser
```bash
$ python manage.py createsuperuser
```
> 👉 Start the app
```bash
$ python manage.py runserver
```
At this point, the app runs at `http://127.0.0.1:8000/`.
## Codebase structure
The project is coded using a simple and intuitive structure presented below:
```bash
< PROJECT ROOT >
|
|-- core/
| |-- settings.py # Project Configuration
| |-- urls.py # Project Routing
|
|-- home/
| |-- views.py # APP Views
| |-- urls.py # APP Routing
| |-- models.py # APP Models
| |-- tests.py # Tests
| |-- templates/ # Theme Customisation
| |-- includes #
| |-- custom-footer.py # Custom Footer
|
|-- requirements.txt # Project Dependencies
|
|-- env.sample # ENV Configuration (default values)
|-- manage.py # Start the app - Django default start script
|
|-- ************************************************************************
```
## How to Customize
When a template file is loaded in the controller, `Django` scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found.
The theme used to style this starter provides the following files:
```bash
# This exists in ENV: LIB/admin_volt
< UI_LIBRARY_ROOT >
|
|-- templates/ # Root Templates Folder
| |
| |-- accounts/
| | |-- sign-in.html # Sign IN Page
| | |-- sign-up.html # Sign UP Page
| |
| |-- includes/
| | |-- footer.html # Footer component
| | |-- sidebar.html # Sidebar component
| | |-- navigation.html # Navigation Bar
| | |-- scripts.html # Scripts Component
| |
| |-- layouts/
| | |-- base.html # Masterpage
| | |-- base-auth.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Index Page (presentation)
| |-- settings.html # Settings Page
| |-- dashboard.html # Dashboard page
| |-- *.html # All other pages
|
|-- ************************************************************************
```
When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path.
> For instance, if we want to **customize the footer.html** these are the steps:
- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app
- ✅ `Step 2`: configure the project to use this new template directory
- `core/settings.py` TEMPLATES section
- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
- Source PATH: `/LIB/admin_volt/includes/footer.html`
- Destination PATH: `home/templates/includes/footer.html`
> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom footer` can be found at this location:
`home/templates/includes/custom_footer.html`
By default, this file is unused because the `theme` expects `footer.html` (without the `custom-` prefix).
In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django.
In a similar way, all other files and components can be customized easily.
## Deploy on [Render](https://render.com/)
- Create a Blueprint instance
- Go to https://dashboard.render.com/blueprints this link.
- Click `New Blueprint Instance` button.
- Connect your `repo` which you want to deploy.
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
- After that your deployment will start automatically.
At this point, the product should be LIVE.
## [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/)
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design inspired by Google's Material Design. `Volt Dashboard PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
> Features:
- ✅ `Up-to-date Dependencies`
- ✅ `Design`: [Django Theme Volt](https://github.com/app-generator/django-admin-volt-pro) - `PRO Version`
- ✅ `Sections` covered by the design:
- ✅ **Admin section** (reserved for superusers)
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
- ✅ **All Pages** available in for ordinary users
- ✅ `Docker`
- 🚀 `Deployment`
- `CI/CD` flow via `Render`
---
[How to DEBUG Django](https://docs.appseed.us/technologies/django/how-to-debug/) - **Django** starter provided by **[AppSeed](https://appseed.us/)**