-
Notifications
You must be signed in to change notification settings - Fork 151
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3412109
commit 8e845cf
Showing
3 changed files
with
44 additions
and
226 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,220 +1,48 @@ | ||
| # [Volt Dashboard Django](https://appseed.us/product/volt-dashboard/django/) | ||
| # [Django Volt Dashboard](https://app-generator.dev/product/volt-dashboard/django/) | ||
|
|
||
| Open-source **[Django Dashboards](https://appseed.us/admin-dashboards/django/)** built on top of a modern design. **Volt Dashboard** 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 date pickers. | ||
| Open-source **Django Dashboard** built on top of a modern design. **Volt Dashboard** 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 date pickers. | ||
|
|
||
| - 👉 [Volt Dashboard Django](https://appseed.us/product/volt-dashboard/django/) - Product page | ||
| - 👉 [Volt Dashboard Django](https://django-volt.onrender.com) - LIVE Demo | ||
| - 👉 [Django Volt Dashboard](https://app-generator.dev/product/volt-dashboard/django/) - `Product Page` | ||
| - 👉 [Django Volt Dashboard](https://django-volt.onrender.com/) - `LIVE Demo` | ||
| - 👉 [Django Volt Dashboard](https://app-generator.dev/docs/products/django/volt-dashboard/index.html) - `Complete Information` and Support Links | ||
| - [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - a `comprehensive tutorial` | ||
| - `Configuration`: Install Dependencies, Prepare Environment, Setting up the Database | ||
| - `Start with Docker` | ||
| - `Manual Build` | ||
| - `Start the project` | ||
| - `Deploy on Render` | ||
|
|
||
| <br /> | ||
|
|
||
| ## Features | ||
|
|
||
| > `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed** | ||
| - **Django 4.1.12** | ||
| - Best Practices | ||
| - **Volt Dashboard Dashboard** - Full Integration | ||
| - `CI/CD` Flow via Render | ||
| - `Docker` | ||
|
|
||
| | Free Version | [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/) | [Custom Development](https://appseed.us/custom-development/) | | ||
| | --------------------------------------| --------------------------------------| --------------------------------------| | ||
| | ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: | | ||
| | ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1 Week** `Custom Development` | | ||
| | ✓ Bootstrap 5 Design | ✅ `OAuth` GitHub | ✅ **Team**: PM, Developer, Tester | | ||
| | ✓ `CI/CD` Flow via Render | ✅ `API`, **[Charts](https://django-volt-dashboard-pro.onrender.com/charts/)** | ✅ Weekly Sprints | | ||
| | ✓ `Docker` | ✅ **[DataTables](https://django-volt-dashboard-pro.onrender.com/tables/)** (Filters, Export) | ✅ Technical SPECS | | ||
| | ✓ `Free Support` (GitHub Issues) |✅ **Celery** | ✅ Documentation | | ||
| | - | ✅ **Media Files Manager** | ✅ **30 days Delivery Warranty** | | ||
| | - | ✅ **Extended User Profiles** | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** | | ||
| | - | ✅ `Private REPO Access` | - | | ||
| | - | ✅ **[Premium Support](https://appseed.us/support/)** | - | | ||
| | ------------------------------------ | ------------------------------------ | ------------------------------------| | ||
| | ✓ [LIVE Demo](https://django-volt.onrender.com) | 🚀 [LIVE Demo](https://django-volt-dashboard-pro.onrender.com/) | **[Get in Touch ➡️](https://appseed.us/custom-development/)** | | ||
|
|
||
|
|
||
|  | ||
|
|
||
| <br /> | ||
|
|
||
| ## Manual Build | ||
|
|
||
| > 👉 Download the code | ||
| ```bash | ||
| $ git clone https://github.com/app-generator/django-volt-dashboard.git | ||
| $ cd django-volt-dashboard | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 Install modules via `VENV` | ||
| ```bash | ||
| $ virtualenv env | ||
| $ source env/bin/activate | ||
| $ pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 Set Up Database | ||
| ```bash | ||
| $ python manage.py makemigrations | ||
| $ python manage.py migrate | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 Create the Superuser | ||
| ```bash | ||
| $ python manage.py createsuperuser | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 Start the app | ||
| ```bash | ||
| $ python manage.py runserver | ||
| ``` | ||
|
|
||
| At this point, the app runs at `http://127.0.0.1:8000/`. | ||
|  | ||
|
|
||
| <br /> | ||
|
|
||
| ## 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 | ||
| | | ||
| |-- ************************************************************************ | ||
| ``` | ||
|
|
||
| <br /> | ||
| ## [Volt Dashboard PRO Version](https://app-generator.dev/product/volt-dashboard-pro/django/) | ||
|
|
||
| ## Compile SCSS | ||
| > The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-volt-dashboard-pro.onrender.com). | ||
| - Install NodeJS and Pmpm | ||
| - `$ node --version # v18.15.0` | ||
| - `$ pnpm --version # 8.6.0` | ||
| - Navigate to `static` and compile the SCSS | ||
|
|
||
| ```bash | ||
| $ cd static | ||
| $ pnpm i # install modules | ||
| $ gulp scss # compile SCSS, output saved in static\css | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| ## 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: `<YOUR_ENV>/LIB/admin_volt/includes/footer.html` | ||
| - Destination PATH: `<PROJECT_ROOT>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. | ||
|
|
||
| <br /> | ||
|
|
||
| ## 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. | ||
|
|
||
| <br /> | ||
|
|
||
| ## [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` | ||
|
|
||
| <br /> | ||
| - **Simple, Easy-to-Extend** Codebase | ||
| - **Volt Dashboard** Design - PRO Version | ||
| - Bootstrap 5 CSS | ||
| - **OAuth** - Github | ||
| - **Extended User Profile** | ||
| - **API** via DRF | ||
| - **Charts** via ApexJS | ||
| - **Celery** (async tasks) | ||
| - **Deployment-Ready** for Render | ||
|
|
||
|  | ||
|  | ||
|
|
||
| <br /> | ||
|
|
||
| --- | ||
| [Django Volt Dashboard](https://appseed.us/product/volt-dashboard/django/) - **Django** starter provided by **[AppSeed](https://appseed.us/)** | ||
| [Django Volt Dashboard](https://app-generator.dev/product/volt-dashboard/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev) |
This file was deleted.
Oops, something went wrong.