# djangoadmin **Repository Path**: abdurrahimcs/djangoadmin ## Basic Information - **Project Name**: djangoadmin - **Description**: No description available - **Primary Language**: CSS - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-06-13 - **Last Updated**: 2024-05-13 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # [Django Bootstrap 5](https://appseed.us/admin-dashboards/django-dashboard-volt) Volt [Admin dashboard](https://appseed.us/admin-dashboards) generated by AppSeed in **[Django](https://appseed.us/admin-dashboards/django)** Framework. Volt Dashboard is a free and open source **[Bootstrap 5](https://appseed.us/admin-dashboards/django-dashboard-volt)** 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, datepickers and so on.
> Features - UI-Ready app, SQLite Database, Django Native ORM - Modular design, clean code-base - Session-Based Authentication, Forms validation - Deployment scripts: Docker, Gunicorn / Nginx - Support via **Github** and [Discord](https://discord.gg/fZC6hup).
> Links - [Django Bootstrap 5 Volt](https://appseed.us/admin-dashboards/django-dashboard-volt) - product page - [Django Bootstrap 5 Volt](https://django-volt-dashboard.appseed-srv1.com/) - LIVE deployment - [Django Bootstrap 5 Volt](https://docs.appseed.us/products/django-dashboards/volt) - product documentation
## Want more? Go PRO! PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Support** (via [Discord](https://discord.gg/fZC6hup)) | [Django Datta PRO](https://appseed.us/admin-dashboards/django-dashboard-dattaable-pro) | [Django Material PRO](https://appseed.us/admin-dashboards/django-dashboard-material-pro) | [Django Volt PRO](https://appseed.us/admin-dashboards/django-dashboard-volt-pro) | | --- | --- | --- | | [![Django Datta PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-dattaable-pro/master/media/django-dashboard-dattaable-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-dattaable-pro) | [![Django Material PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-material-pro/master/media/django-dashboard-material-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-material-pro) | [![Django Volt PRO](https://raw.githubusercontent.com/app-generator/django-dashboard-volt-pro/master/media/django-dashboard-volt-pro-screen.png)](https://appseed.us/admin-dashboards/django-dashboard-volt-pro)

![Django Bootstrap 5 Volt - Template project provided by AppSeed.](https://raw.githubusercontent.com/app-generator/django-dashboard-volt/master/media/django-dashboard-volt-screen.png)
## How to use it ```bash $ # Get the code $ git clone https://github.com/app-generator/django-dashboard-volt.git $ cd django-dashboard-volt $ $ # Virtualenv modules installation (Unix based systems) $ virtualenv env $ source env/bin/activate $ $ # Virtualenv modules installation (Windows based systems) $ # virtualenv env $ # .\env\Scripts\activate $ $ # Install modules - SQLite Storage $ pip3 install -r requirements.txt $ $ # Create tables $ python manage.py makemigrations $ python manage.py migrate $ $ # Start the application (development mode) $ python manage.py runserver # default port 8000 $ $ # Start the app - custom port $ # python manage.py runserver 0.0.0.0: $ $ # Access the web app in browser: http://127.0.0.1:8000/ ``` > Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages.
## Code-base structure The project is coded using a simple and intuitive structure presented bellow: ```bash < PROJECT ROOT > | |-- core/ # Implements app logic and serve the static assets | |-- settings.py # Django app bootstrapper | |-- wsgi.py # Start the app in production | |-- urls.py # Define URLs served by all apps/nodes | | | |-- static/ | | |-- # CSS files, Javascripts files | | | |-- templates/ # Templates used to render pages | | | |-- includes/ # HTML chunks and components | | |-- navigation.html # Top menu component | | |-- sidebar.html # Sidebar component | | |-- footer.html # App Footer | | |-- scripts.html # Scripts common to all pages | | | |-- layouts/ # Master pages | | |-- base-fullscreen.html # Used by Authentication pages | | |-- base.html # Used by common pages | | | |-- accounts/ # Authentication pages | | |-- login.html # Login page | | |-- register.html # Register page | | | index.html # The default page | page-404.html # Error 404 page | page-500.html # Error 404 page | *.html # All other HTML pages | |-- authentication/ # Handles auth routes (login and register) | | | |-- urls.py # Define authentication routes | |-- views.py # Handles login and registration | |-- forms.py # Define auth forms | |-- app/ # A simple app that serve HTML files | | | |-- views.py # Serve HTML pages for authenticated users | |-- urls.py # Define some super simple routes | |-- requirements.txt # Development modules - SQLite storage | |-- .env # Inject Configuration via Environment |-- manage.py # Start the app - Django default start script | |-- ************************************************************************ ```
> The bootstrap flow - Django bootstrapper `manage.py` uses `core/settings.py` as the main configuration file - `core/settings.py` loads the app magic from `.env` file - Redirect the guest users to Login page - Unlock the pages served by *app* node for authenticated users
## Deployment The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/). ### [Docker](https://www.docker.com/) execution --- The application can be easily executed in a docker container. The steps: > Get the code ```bash $ git clone https://github.com/app-generator/django-dashboard-volt.git $ cd django-dashboard-volt ``` > Start the app in Docker ```bash $ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d ``` Visit `http://localhost:5005` in your browser. The app should be up & running.
### [Gunicorn](https://gunicorn.org/) --- Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX. > Install using pip ```bash $ pip install gunicorn ``` > Start the app using gunicorn binary ```bash $ gunicorn --bind=0.0.0.0:8001 core.wsgi:application Serving on http://localhost:8001 ``` Visit `http://localhost:8001` in your browser. The app should be up & running.
### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/) --- Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library. > Install using pip ```bash $ pip install waitress ``` > Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html) ```bash $ waitress-serve --port=8001 core.wsgi:application Serving on http://localhost:8001 ``` Visit `http://localhost:8001` in your browser. The app should be up & running.
## Credits & Links - [Django](https://www.djangoproject.com/) - The official website - [Boilerplate Code](https://appseed.us/boilerplate-code) - Index provided by **AppSeed** - [Boilerplate Code](https://github.com/app-generator/boilerplate-code) - Index published on Github
--- [Django Bootstrap 5](https://appseed.us/admin-dashboards/django-dashboard-volt) Volt - Provided by **AppSeed [App Generator](https://appseed.us/app-generator)**.