Skip to content

Commit 178da6a

Browse files
app-generatorapp-generator
authored
Update README.md
1 parent da25662 commit 178da6a

File tree

1 file changed

+32
-185
lines changed

1 file changed

+32
-185
lines changed

‎README.md

+32-185
Original file line numberDiff line numberDiff line change
@@ -1,203 +1,50 @@
1-
# [Django Dashboard Tabler](https://appseed.us/product/tabler/django/)
21

3-
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`.
2+
# [Django Tabler](https://app-generator.dev/product/tabler/django/)
43

5-
- 👉 [Django Tabler](https://appseed.us/product/tabler/django/) - `Product page`
6-
- 👉 [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/) - Volt BS5 Design
4+
Open-source **Django** project crafted on top of **Tabler Design**, an open-source iconic `Bootstrap` design.
5+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
76

7+
- 👉 [Django Tabler](https://app-generator.dev/product/tabler/django/) - `Product Page`
8+
- 👉 [Django Tabler](https://django-tabler.onrender.com/) - `LIVE Demo`
9+
- 👉 [Django Tabler Documentation](https://app-generator.dev/docs/products/django/tabler/index.html) - `Complete Information` and Support Links
10+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - a `comprehensive tutorial`
11+
- `Configuration`: Install Tailwind/Flowbite, Prepare Environment, Setting up the Database
12+
- `Start with Docker`
13+
- `Manual Build`
14+
- `Start the project`
15+
- `Deploy on Render`
16+
817
<br />
918

1019
## Features
1120

12-
> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed**
21+
- **Django 4.1.12**
22+
- Best Practices
23+
- [Tabler](https://app-generator.dev/docs/templates/bootstrap/tabler.html) - Full Integration
24+
- `CI/CD` Flow via Render
25+
- `Docker`
1326

14-
| Free Version | [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/) | [Custom Development](https://appseed.us/custom-development/) |
15-
| --------------------------------------| --------------------------------------| --------------------------------------|
16-
| ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: |
17-
| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1mo Custom Development** |
18-
| ✓ Bootstrap 5 Design | ✅ `OAuth` Google, GitHub | ✅ **Team**: PM, Developer, Tester |
19-
| ✓ `CI/CD` Flow via Render | ✅ `API`, **[Charts](https://django-volt-dashboard-pro.onrender.com/charts/)** | ✅ Weekly Sprints |
20-
| ✓ `Docker` | ✅ **[DataTables](https://django-volt-dashboard-pro.onrender.com/tables/)** (Filters, Export) | ✅ Technical SPECS |
21-
| - |✅ **Celery** | ✅ Documentation |
22-
| - | ✅ **Media Files Manager** | ✅ **30 days Delivery Warranty** |
23-
| - | ✅ **Extended User Profiles** | - |
24-
| - | ✅ `Private REPO Access` | - |
25-
| - | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/) | - |
26-
| - | ✅ Deployment Assistance | - |
27-
| ------------------------------------ | ------------------------------------ | ------------------------------------|
28-
| ✓ [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/)** |
29-
30-
![Django Dashboard Tabler](https://github.com/user-attachments/assets/f1fa943d-7e6c-4346-9734-281a8cd2e093)
31-
32-
<br />
33-
34-
## Start with `Docker`
35-
36-
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
37-
38-
```bash
39-
$ git clone https://github.com/app-generator/django-tabler.git
40-
$ cd django-tabler
41-
```
42-
43-
<br />
44-
45-
> 👉 **Step 2** - Start the APP in `Docker`
46-
47-
```bash
48-
$ docker-compose up --build
49-
```
50-
51-
Visit `http://localhost:5085` in your browser. The app should be up & running.
52-
53-
<br />
54-
55-
## Environment
56-
57-
Create a new `.env` file using sample `env.sample`. The meaning of each variable can be found below:
58-
59-
- `DEBUG`: if `True` the app runs in develoment mode
60-
- For production value `False` should be used
61-
- For `MySql` persistence
62-
- Install the DB Driver: `pip install mysqlclient`
63-
- Create DB and assign a new user (full rights)
64-
- Edit `.env` to match the DB, user, password ..
65-
66-
<br />
67-
68-
## Manual Build
69-
70-
> Download the code
71-
72-
```bash
73-
$ git clone https://github.com/app-generator/django-tabler.git
74-
$ cd django-tabler
75-
```
76-
77-
<br />
78-
79-
### 👉 Set Up for `Unix`, `MacOS`
80-
81-
> Install modules via `VENV`
82-
83-
```bash
84-
$ virtualenv env
85-
$ source env/bin/activate
86-
$ pip3 install -r requirements.txt
87-
```
88-
89-
<br />
90-
91-
> Set Up Database
92-
93-
```bash
94-
$ python manage.py makemigrations
95-
$ python manage.py migrate
96-
```
27+
![Django Dashboard Tabler - Open-Source ](https://github.com/user-attachments/assets/f1fa943d-7e6c-4346-9734-281a8cd2e093)
9728

9829
<br />
9930

100-
> Start the APP
101-
102-
```bash
103-
$ python manage.py createsuperuser # create the admin
104-
$ python manage.py runserver # start the project
105-
```
106-
107-
At this point, the app runs at `http://127.0.0.1:8000/`.
108-
109-
<br />
110-
111-
### 👉 Set Up for `Windows`
112-
113-
> Install modules via `VENV` (windows)
114-
115-
```
116-
$ virtualenv env
117-
$ .\env\Scripts\activate
118-
$ pip3 install -r requirements.txt
119-
```
120-
121-
<br />
122-
123-
> Set Up Database
124-
125-
```bash
126-
$ python manage.py makemigrations
127-
$ python manage.py migrate
128-
```
129-
130-
<br />
131-
132-
> Start the APP
133-
134-
```bash
135-
$ python manage.py createsuperuser # create the admin
136-
$ python manage.py runserver # start the project
137-
```
138-
139-
At this point, the app runs at `http://127.0.0.1:8000/`.
140-
141-
<br />
142-
143-
## Codebase Structure
144-
145-
The project is coded using a simple and intuitive structure presented below:
146-
147-
```bash
148-
< PROJECT ROOT >
149-
|
150-
|-- core/
151-
| |-- settings.py # Project Configuration
152-
| |-- urls.py # Project Routing
153-
|
154-
|-- home/
155-
| |-- views.py # APP Views
156-
| |-- urls.py # APP Routing
157-
| |-- models.py # APP Models
158-
| |-- tests.py # Tests
159-
|
160-
|-- requirements.txt # Project Dependencies
161-
|
162-
|-- env.sample # ENV Configuration (default values)
163-
|-- manage.py # Start the app - Django default start script
164-
|
165-
|-- ************************************************************************
166-
```
167-
168-
<br />
169-
170-
## Deploy on [Render](https://render.com/)
171-
172-
- Create a Blueprint instance
173-
- Go to https://dashboard.render.com/blueprints this link.
174-
- Click `New Blueprint Instance` button.
175-
- Connect your `repo` which you want to deploy.
176-
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
177-
- After that your deployment will start automatically.
178-
179-
At this point, the product should be LIVE.
180-
181-
<br />
182-
183-
## [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/)
184-
185-
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.
31+
## [Material Dashboard PRO Version](https://app-generator.dev/product/material-dashboard-pro/django/)
18632

187-
> Features:
33+
> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-material-dash2-pro.onrender.com).
18834
189-
- `Up-to-date Dependencies`
190-
- `Design`: [Django Theme Volt](https://github.com/app-generator/django-volt-dashboard-pro) - `PRO Version`
191-
- `Sections` covered by the design:
192-
- **Admin section** (reserved for superusers)
193-
- **Authentication**: `Django.contrib.AUTH`, Registration
194-
- **All Pages** available in for ordinary users
195-
- `Docker`, `Deployment`:
196-
- `CI/CD` flow via `Render`
35+
- **Simple, Easy-to-Extend** Codebase
36+
- **Material Dashboard** Design - PRO Version
37+
- Bootstrap 5 CSS
38+
- **OAuth** - Github
39+
- **Extended User Profile**
40+
- **API** via DRF
41+
- **Charts** via ApexJS
42+
- **Celery** (async tasks)
43+
- **Deployment-Ready** for Render
19744

198-
![Volt Dashboard PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/172672843-8c40a801-3438-4e9c-86db-38a34191fbdf.png)
45+
![Django Material Dash2 PRO - Premium starter crafted by App-Generator.](https://github.com/user-attachments/assets/c75c6e67-a940-4d56-9855-070f901ab5ab)
19946

20047
<br />
20148

20249
---
203-
[Django Dashboard Tabler](https://appseed.us/product/tabler/django/) - Open-source starter generated by **[AppSeed](https://appseed.us/)**.
50+
[Django Tabler](https://app-generator.dev/product/tabler/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev)

0 commit comments

Comments
 (0)