Skip to content

Commit 6b43ac6

Browse files
app-generatorapp-generator
committed
Update soft-ui-dashboard-pro.mdx
1 parent e157faa commit 6b43ac6

File tree

1 file changed

+69
-140
lines changed

1 file changed

+69
-140
lines changed

‎docs/products/django-dashboards/soft-ui-dashboard-pro.mdx‎

Lines changed: 69 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
11
---
22
title: Django Soft PRO - Premium Starter
33
sidebar_label: Django Soft PRO
4+
canonical: https://appseed.us/product/argon-dashboard2-pro/django/
45
---
56

6-
# [Django Soft Django](https://appseed.us/product/soft-ui-dashboard-pro/django/)
7+
# [Django Soft PRO](https://appseed.us/product/soft-ui-dashboard-pro/django/)
78

8-
<SubHeading>Premium Django Starter coded on top Soft UI Bootstrap design (Premium Version).</SubHeading>
9+
<SubHeading>Premium Django Starter coded on top of Soft Dashboard PRO design (Premium Version).</SubHeading>
910

10-
Premium **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** generated by `AppSeed` on top of a modern Bootstrap 5 design.
11-
**[Soft UI Dashboard](https://appseed.us/product/soft-ui-dashboard-pro/django/)** is a premium `Bootstrap 5` Admin Dashboard featuring over 100 components, 11 example pages and 3 plugins with Vanilla JS.
11+
**Django** starter styled with **[Soft Dashboard PRO](https://appseed.us/product/soft-ui-dashboard-pro/django/)**, a premium `Bootstrap 5` KIT from `Creative-Tim`.
12+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
1213

1314
- 👉 [Soft UI Dashboard PRO Django](https://appseed.us/product/soft-ui-dashboard-pro/django/) - `Product Page`
14-
- 👉 [Soft UI Dashboard PRO Django](https://django-soft-dash-pro.onrender.com) - `LIVE Demo`
15+
- 👉 [Soft UI Dashboard PRO Django](https://django-soft-dash-pro.onrender.com/) - `LIVE Demo`
1516

16-
:::info [**v1.0.6**](https://github.com/app-generator/django-soft-ui-dashboard-pro/releases) - release date `2023-01-29`
17+
:::info [**v1.0.19**](https://github.com/app-generator/django-soft-ui-dashboard-pro/releases) - release date `2024-08-09`
1718
:::
1819

19-
20-
## ✅ **Features**
21-
22-
- `Up-to-date Dependencies`
23-
- UI Theme: [Soft Dashboard PRO](/boilerplate-code/django-templates/soft-dashboard-pro/)
24-
- can be used in any Django project (new or legacy)
25-
- `Sections` covered by the design:
26-
- **Admin section** (reserved for superusers)
27-
- **Authentication**: `Django.contrib.AUTH`, Registration
28-
- **All Pages** available in for ordinary users
20+
## **Features**
21+
22+
- `Up-to-date dependencies`
23+
- Database: `SQLite` (default), PgSQL, MySql
24+
- **Authentication**
25+
- `Session-Based authentication`
26+
- `Social Login`: **Github**
27+
- **User Extended profile**
28+
- **API** via DRF
29+
- DataTables
30+
- Charts
31+
- Celery (Async Tasks)
32+
- File Manager
2933
- `Docker`
30-
- `Deployment`
31-
- `CI/CD` flow via `Render`
3234

33-
![Soft UI Dashboard PRO - Premium Django Starter](https://user-images.githubusercontent.com/51070104/215729645-658632c1-1eec-4abc-baaa-f1d3deca29ad.png)
35+
![Soft Dashboard PRO Django](https://github.com/user-attachments/assets/f9e11d47-b009-40cc-9ea3-b50dc5030b80)
3436

37+
<br />
3538

36-
## ✅ Environment
39+
## Environment
3740

3841
To use the starter, [Python3](https://www.python.org) should be installed properly in the workstation.
3942
If you are not sure if Python is installed, please open a terminal and type `python --version`. Here is the full list with dependencies and tools required to build the app:
@@ -43,172 +46,98 @@ If you are not sure if Python is installed, please open a terminal and type `pyt
4346
- Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
4447
- (Optional) `Docker` - a popular virtualization software
4548

49+
<br />
4650

47-
## ✅ Manual Build
51+
## Start in `Docker`
4852

49-
> 👉 Download the code
53+
> **Step 1** - Download the [code](https://appseed.us/product/soft-ui-dashboard-pro/django/) and unzip the sources (requires a `purchase`).
5054
5155
```bash
52-
$ git clone https://github.com/app-generator/django-soft-ui-dashboard-pro.git
53-
$ cd django-soft-ui-dashboard-pro
56+
$ unzip soft-ui-dashboard-pro.zip
57+
$ cd soft-ui-dashboard-pro
5458
```
5559

5660
<br />
5761

58-
> Export `GITHUB_TOKEN` in the environment. The value is provided by AppSeed during purchase.
59-
60-
This is required because the project has a private REPO dependency: `github.com/app-generator/priv-django-admin-soft-pro`
62+
> **Step 2** - Start the APP in `Docker`
6163
6264
```bash
63-
$ export GITHUB_TOKEN='TOKEN_HERE' # for Linux, Mac
64-
$ set GITHUB_TOKEN='TOKEN_HERE' # Windows CMD
65-
$ $env:GITHUB_TOKEN = 'TOKEN_HERE' # Windows powerShell
65+
# Optional (kill all existing containers)
66+
$ docker container kill $(docker ps -q) ; docker container rm $(docker ps -a -q) ; docker network prune -f
67+
# Start the APP
68+
$ docker-compose up --build
6669
```
6770

68-
> 👉 Install modules via `VENV`.
71+
Visit `http://localhost:5085` in your browser. The app should be up & running.
6972

73+
<br />
74+
75+
## Manual Build
76+
77+
> **Step 1** - Download the [code](https://appseed.us/product/soft-ui-dashboard-pro/django/) and unzip the sources (requires a `purchase`).
7078
7179
```bash
72-
$ virtualenv env
73-
$ source env/bin/activate
74-
$ pip install -r requirements.txt
80+
$ unzip soft-ui-dashboard-pro.zip
81+
$ cd soft-ui-dashboard-pro
7582
```
7683

77-
> 👉 Edit the `.env` using the template `.env.sample`.
84+
> **Step 2** - Create new `.env` from `env.sample`
7885
79-
```env
86+
The meaning of each variable can be found below:
8087

81-
# True for development, False for production
82-
DEBUG=True
88+
- `DEBUG`: if `True` the app runs in develoment mode
89+
- For production value `False` should be used
90+
- Edit `SECRET_KEY`: add strong secret key
8391

92+
> **Step 3** - Activate the Virtual Environment and Install Modules
93+
94+
```bash
95+
$ virtualenv env
96+
$ source env/bin/activate
97+
$ pip install -r requirements.txt
8498
```
8599

86-
> 👉 Set Up Database
100+
> **Step 4** - Migrate Database (by Default SQLite is used)
87101
88102
```bash
89103
$ python manage.py makemigrations
90104
$ python manage.py migrate
91105
```
92106

93-
> 👉 Create the Superuser
107+
> **Step 5** - Create Superuser
94108
95109
```bash
96110
$ python manage.py createsuperuser
97111
```
98112

99-
> 👉 Start the app
113+
> **Step 6** - Start the App
100114
101115
```bash
102116
$ python manage.py runserver
103117
```
104118

105119
At this point, the app runs at `http://127.0.0.1:8000/`.
106120

121+
<br />
107122

108-
## ✅ Manage App `Users`
109-
110-
By default, the starter is not provided with users. To access the private pages and the admin section (reserved for `superusers`) follow up the next sections.
111-
112-
### 👉 Create `Superusers`
113-
114-
To access the `admin` section, Django requires `superuser` privilegies. Let's create a new `superuser` and access the `admin` section of the project:
115-
116-
```bash
117-
$ python manage.py createsuperuser
118-
```
119-
120-
Once the `superuser` is successfully created, we can access the `admin` section:
121-
122-
`http://localhost:8000/admin/`
123-
124-
125-
## ✅ Codebase structure
126-
127-
The project is coded using a simple and intuitive structure presented below:
128-
129-
```bash
130-
< PROJECT ROOT >
131-
|
132-
|-- core/
133-
| |-- settings.py # Project Configuration
134-
| |-- urls.py # Project Routing
135-
|
136-
|-- home/
137-
| |-- views.py # APP Views
138-
| |-- urls.py # APP Routing
139-
| |-- models.py # APP Models
140-
| |-- tests.py # Tests
141-
| |-- templates/ # Theme Customisation
142-
| |-- includes #
143-
| |-- custom-footer.py # Custom Footer
144-
|
145-
|
146-
|-- requirements.txt # Project Dependencies
147-
|
148-
|-- env.sample # ENV Configuration (default values)
149-
|-- manage.py # Start the app - Django default start script
150-
|
151-
|-- ************************************************************************
152-
```
153-
154-
155-
## ✅ How to Customize
123+
## Start Celery
156124

157-
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.
158-
The theme used to style this starter provides the following files:
125+
- Make sure you have a Redis Server running: `redis://localhost:6379`
126+
- `$ redis-cli` and type `ping`
127+
- In the base directory inside `tasks_scripts` folder you need to write your scripts file.
128+
- Run the celery command from the CLI.
159129

160130
```bash
161-
# This is saved in ENV: LIB/admin_soft_pro
162-
< UI_LIBRARY_ROOT >
163-
164-
|
165-
|-- templates/ # Root Templates Folder
166-
| |
167-
| |-- accounts/
168-
| | |-- signin/basic.html # Sign IN Page
169-
| | |-- signup/basic.html # Sign UP Page
170-
| |
171-
| |-- includes/
172-
| | |-- footer.html # Footer component
173-
| | |-- sidebar.html # Sidebar component
174-
| | |-- navigation.html # Navigation Bar
175-
| | |-- scripts.html # Scripts Component
176-
| |
177-
| |-- layouts/
178-
| | |-- base.html # Masterpage
179-
| | |-- base-fullscreen.html # Masterpage for Auth Pages
180-
| |
181-
| |-- pages/
182-
| |-- widgets.html # Widgets page
183-
| |-- messages.html # Messaging APP Page
184-
| |-- *.html # All other pages
185-
|
186-
|-- ************************************************************************
131+
$ export DJANGO_SETTINGS_MODULE="core.settings"
132+
$ celery -A apps.tasks worker -l info -B
187133
```
188134

189-
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.
190-
191-
> For instance, if we want to **customize the footer.html** these are the steps:
192-
193-
- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app
194-
- ✅ `Step 2`: configure the project to use this new template directory
195-
- `core/settings.py` TEMPLATES section
196-
- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
197-
- Source PATH: `<YOUR_ENV>/LIB/admin_soft_pro/includes/footer.html`
198-
- Destination PATH: `<PROJECT_ROOT>home/templates/includes/footer.html`
199-
200-
> 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:
201-
202-
`home/templates/includes/custom_footer.html`
203-
204-
By default, this file is unused because the `theme` expects `footer.html` (without the `custom_` prefix).
205-
206-
In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django.
207-
208-
In a similar way, all other files and components can be customized easily.
135+
- You will see a new route `Apps -> Tasks` in the sidebar.
136+
- You can start and cancel any task from the UI.
209137

138+
<br />
210139

211-
## ✅ Deploy on [Render](https://render.com/)
140+
## Deploy on [Render](https://render.com/)
212141

213142
- Create a Blueprint instance
214143
- Go to https://dashboard.render.com/blueprints this link.
@@ -219,7 +148,7 @@ In a similar way, all other files and components can be customized easily.
219148

220149
At this point, the product should be LIVE.
221150

222-
## ✅ Resources
151+
## Resources
223152

224153
- 👉 Access [AppSeed](https://appseed.us/) for more starters and support
225-
- 👉 Get in touch for **[Custom Development Services](https://appseed.us/custom-development/)**
154+
- 👉 Get in touch for [Custom Development Services](https://appseed.us/custom-development/)

0 commit comments

Comments
 (0)