-
Notifications
You must be signed in to change notification settings - Fork 30
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
da25662
commit 178da6a
Showing
1 changed file
with
32 additions
and
185 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,203 +1,50 @@ | ||
| # [Django Dashboard Tabler](https://appseed.us/product/tabler/django/) | ||
|
|
||
| Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** generated by AppSeed op top of an iconic design. **Tabler** is a open-source admin template crafted by Codecalm agency. It comes with the basic components and set of pre-built pages required to lay the foundation for any application - Design provided by `Codecalm`. | ||
| # [Django Tabler](https://app-generator.dev/product/tabler/django/) | ||
|
|
||
| - 👉 [Django Tabler](https://appseed.us/product/tabler/django/) - `Product page` | ||
| - 👉 [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/) - Volt BS5 Design | ||
| Open-source **Django** project crafted on top of **Tabler Design**, an open-source iconic `Bootstrap` design. | ||
| The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. | ||
|
|
||
| - 👉 [Django Tabler](https://app-generator.dev/product/tabler/django/) - `Product Page` | ||
| - 👉 [Django Tabler](https://django-tabler.onrender.com/) - `LIVE Demo` | ||
| - 👉 [Django Tabler Documentation](https://app-generator.dev/docs/products/django/tabler/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 Tailwind/Flowbite, 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 | ||
| - [Tabler](https://app-generator.dev/docs/templates/bootstrap/tabler.html) - 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** | ✅ **1mo Custom Development** | | ||
| | ✓ Bootstrap 5 Design | ✅ `OAuth` Google, 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 | | ||
| | - |✅ **Celery** | ✅ Documentation | | ||
| | - | ✅ **Media Files Manager** | ✅ **30 days Delivery Warranty** | | ||
| | - | ✅ **Extended User Profiles** | - | | ||
| | - | ✅ `Private REPO Access` | - | | ||
| | - | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/) | - | | ||
| | - | ✅ Deployment Assistance | - | | ||
| | ------------------------------------ | ------------------------------------ | ------------------------------------| | ||
| | ✓ [Product Page](https://appseed.us/product/tabler/django/) | 🚀 [LIVE Demo](https://django-volt-dashboard-pro.onrender.com/) | **[Get in Touch ➡️](https://appseed.us/custom-development/)** | | ||
|
|
||
|  | ||
|
|
||
| <br /> | ||
|
|
||
| ## Start with `Docker` | ||
|
|
||
| > 👉 **Step 1** - Download the code from the GH repository (using `GIT`) | ||
| ```bash | ||
| $ git clone https://github.com/app-generator/django-tabler.git | ||
| $ cd django-tabler | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 **Step 2** - Start the APP in `Docker` | ||
| ```bash | ||
| $ docker-compose up --build | ||
| ``` | ||
|
|
||
| Visit `http://localhost:5085` in your browser. The app should be up & running. | ||
|
|
||
| <br /> | ||
|
|
||
| ## Environment | ||
|
|
||
| Create a new `.env` file using sample `env.sample`. The meaning of each variable can be found below: | ||
|
|
||
| - `DEBUG`: if `True` the app runs in develoment mode | ||
| - For production value `False` should be used | ||
| - For `MySql` persistence | ||
| - Install the DB Driver: `pip install mysqlclient` | ||
| - Create DB and assign a new user (full rights) | ||
| - Edit `.env` to match the DB, user, password .. | ||
|
|
||
| <br /> | ||
|
|
||
| ## Manual Build | ||
|
|
||
| > Download the code | ||
| ```bash | ||
| $ git clone https://github.com/app-generator/django-tabler.git | ||
| $ cd django-tabler | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| ### 👉 Set Up for `Unix`, `MacOS` | ||
|
|
||
| > Install modules via `VENV` | ||
| ```bash | ||
| $ virtualenv env | ||
| $ source env/bin/activate | ||
| $ pip3 install -r requirements.txt | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > Set Up Database | ||
| ```bash | ||
| $ python manage.py makemigrations | ||
| $ python manage.py migrate | ||
| ``` | ||
|  | ||
|
|
||
| <br /> | ||
|
|
||
| > Start the APP | ||
| ```bash | ||
| $ python manage.py createsuperuser # create the admin | ||
| $ python manage.py runserver # start the project | ||
| ``` | ||
|
|
||
| At this point, the app runs at `http://127.0.0.1:8000/`. | ||
|
|
||
| <br /> | ||
|
|
||
| ### 👉 Set Up for `Windows` | ||
|
|
||
| > Install modules via `VENV` (windows) | ||
| ``` | ||
| $ virtualenv env | ||
| $ .\env\Scripts\activate | ||
| $ pip3 install -r requirements.txt | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > Set Up Database | ||
| ```bash | ||
| $ python manage.py makemigrations | ||
| $ python manage.py migrate | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > Start the APP | ||
| ```bash | ||
| $ python manage.py createsuperuser # create the admin | ||
| $ python manage.py runserver # start the project | ||
| ``` | ||
|
|
||
| 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 | ||
| | | ||
| |-- requirements.txt # Project Dependencies | ||
| | | ||
| |-- env.sample # ENV Configuration (default values) | ||
| |-- manage.py # Start the app - Django default start script | ||
| | | ||
| |-- ************************************************************************ | ||
| ``` | ||
|
|
||
| <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. `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. | ||
| ## [Material Dashboard PRO Version](https://app-generator.dev/product/material-dashboard-pro/django/) | ||
|
|
||
| > Features: | ||
| > The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-material-dash2-pro.onrender.com). | ||
| - `Up-to-date Dependencies` | ||
| - `Design`: [Django Theme Volt](https://github.com/app-generator/django-volt-dashboard-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` | ||
| - **Simple, Easy-to-Extend** Codebase | ||
| - **Material 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 Dashboard Tabler](https://appseed.us/product/tabler/django/) - Open-source starter generated by **[AppSeed](https://appseed.us/)**. | ||
| [Django Tabler](https://app-generator.dev/product/tabler/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev) |