Reference codebase used by AppSeed
in all Django Dashboard starters - the product uses an amazing design crafted by Creative-Tim
.
- π Boilerplate Django Dashboard -
Product page
- π Boilerplate Django Dashboard -
LIVE Demo
- π Free Support via
Email
&Discord
Features:
- β
Up-to-date Dependencies
- β
Theme: Django Admin Soft, designed by Creative-Tim
can be used in any Django project
(new or legacy)
- β
Authentication:
Django.contrib.AUTH
, Registration - π
Deployment
CI/CD
flow viaRender
- Django Soft - Go LIVE -
video presentation
π Step 1 - Download the code from the GH repository (using
GIT
)
$ git clone https://github.com/app-generator/boilerplate-code-django-dashboard.git
$ cd boilerplate-code-django-dashboard
π Step 2 - Start the APP in
Docker
$ docker-compose up --build
Visit http://localhost:5085
in your browser. The app should be up & running.
π Download the code
$ git clone https://github.com/app-generator/boilerplate-code-django-dashboard.git
$ cd boilerplate-code-django-dashboard
π Install modules via
VENV
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
π Set Up Database
$ python manage.py makemigrations
$ python manage.py migrate
π Create the Superuser
$ python manage.py createsuperuser
π Start the app
$ python manage.py runserver
At this point, the app runs at http://127.0.0.1:8000/
.
The project is coded using a simple and intuitive structure presented below:
< 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
|
|-- ************************************************************************
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:
# This exists in ENV: LIB/admin_soft
< UI_LIBRARY_ROOT >
|
|-- templates/ # Root Templates Folder
| |
| |-- accounts/
| | |-- login.html # Sign IN Page
| | |-- register.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-fullscreen.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Dashboard page
| |-- profile.html # Settings 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 thetemplates
DIRECTORY inside thehome
app - β
Step 2
: configure the project to use this new template directorycore/settings.py
TEMPLATES section
- β
Step 3
: copy thefooter.html
from the original location (inside your ENV) and save it to thehome/templates
DIR- Source PATH:
<YOUR_ENV>/LIB/admin_soft/includes/footer.html
- Destination PATH:
<PROJECT_ROOT>home/templates/includes/footer.html
- Source PATH:
To speed up all these steps, the codebase is already configured (
Steps 1, and 2
) and acustom 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
- 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 onUpdate Existing Resources
button. - After that your deployment will start automatically.
At this point, the product should be LIVE.
Django Boilerplate - Django starter provided by AppSeed