Skip to content

Commit 14b3922

Browse files
app-generatorapp-generator
authored
Update README.md
1 parent ef4f1d1 commit 14b3922

File tree

1 file changed

+32
-161
lines changed

1 file changed

+32
-161
lines changed

‎README.md‎

Lines changed: 32 additions & 161 deletions
Original file line numberDiff line numberDiff line change
@@ -1,179 +1,50 @@
1-
# [Django Soft Dashboard](https://appseed.us/product/soft-ui-dashboard/django/)
21

3-
Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** crafted on top of **Soft UI Dashboard**, an open-source `Bootstrap 5` design from `Creative-Tim`.
4-
Designed for those who like bold elements and beautiful websites. Made of hundreds of elements, designed blocks and fully coded pages, `Soft UI Dashboard` is ready to help you create stunning websites and web apps.
2+
# [Django Soft Dashboard](https://app-generator.dev/product/soft-ui-dashboard/django/)
53

6-
- 👉 [Django Soft Dashboard](https://appseed.us/product/soft-ui-dashboard/django/) - `Product page`
7-
- 👉 [Django Soft Dashboard](https://django-soft-dash.onrender.com) - `LIVE Demo`
4+
Open-source **Django** project crafted on top of **Soft UI Dashboard**, an open-source iconic `Bootstrap` 4 design from Creative-Tim.
5+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
86

7+
- 👉 [Django Material Dashboard](https://app-generator.dev/product/soft-ui-dashboard/django/) - `Product Page`
8+
- 👉 [Django Material Dashboard](https://django-soft-dash.onrender.com/) - `LIVE Demo`
9+
- 👉 [Django Material Dashboard Documentation](https://app-generator.dev/docs/products/django/soft-ui-dashboard/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+
917
<br />
1018

1119
## Features
1220

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

15-
| Free Version | [PRO Version](https://appseed.us/product/soft-ui-dashboard-pro/django/) | [Custom Development](https://appseed.us/custom-development/) |
16-
| --------------------------------------| --------------------------------------| --------------------------------------|
17-
| ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: |
18-
| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1 Week** `Custom Development` |
19-
| ✓ Bootstrap 5, `Material` Design | ✅ `OAuth` GitHub | ✅ **Team**: PM, Developer, Tester |
20-
| ✓ `CI/CD` Flow via Render | ✅ `API`, **[Charts](https://django-soft-dash-pro.onrender.com/charts/)** | ✅ Weekly Sprints |
21-
| ✓ `Docker` | ✅ **[DataTables](https://django-soft-dash-pro.onrender.com/tables/)** (Filters, Export) | ✅ Technical SPECS |
22-
| ✓ `Free Support` (GitHub Issues) |✅ **Celery** | ✅ Documentation |
23-
| - | ✅ **Media Files Manager** | ✅ **30 days Delivery Warranty** |
24-
| - | ✅ **Extended User Profiles** | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** |
25-
| - | ✅ `Private REPO Access` | - |
26-
| - | ✅ **[Premium Support](https://appseed.us/support/)** | - |
27-
| ------------------------------------ | ------------------------------------ | ------------------------------------|
28-
| ✓ [LIVE Demo](https://django-soft-dash.onrender.com) | 🚀 [LIVE Demo](https://django-soft-dash-pro.onrender.com/) | **[Get in Touch ➡️](https://appseed.us/custom-development/)** |
29-
30-
31-
![Django Admin Soft - Template project for Django provided by AppSeed.](https://user-images.githubusercontent.com/51070104/215729207-5cce250e-54da-4712-89a9-c1fd6b0a149e.png)
32-
33-
<br />
34-
35-
## Manual Build
36-
37-
> 👉 Download the code
38-
39-
```bash
40-
$ git clone https://github.com/app-generator/django-soft-ui-dashboard.git
41-
$ cd django-soft-ui-dashboard
42-
```
43-
44-
<br />
45-
46-
> 👉 Install modules via `VENV`
47-
48-
```bash
49-
$ virtualenv env
50-
$ source env/bin/activate
51-
$ pip install -r requirements.txt
52-
```
53-
54-
<br />
55-
56-
> 👉 Set Up Database
57-
58-
```bash
59-
$ python manage.py makemigrations
60-
$ python manage.py migrate
61-
```
62-
63-
<br />
64-
65-
> 👉 Create the Superuser
66-
67-
```bash
68-
$ python manage.py createsuperuser
69-
```
70-
71-
<br />
72-
73-
> 👉 Start the app
74-
75-
```bash
76-
$ python manage.py runserver
77-
```
78-
79-
At this point, the app runs at `http://127.0.0.1:8000/`.
80-
81-
<br />
82-
83-
## Codebase structure
84-
85-
The project is coded using a simple and intuitive structure presented below:
86-
87-
```bash
88-
< PROJECT ROOT >
89-
|
90-
|-- core/
91-
| |-- settings.py # Project Configuration
92-
| |-- urls.py # Project Routing
93-
|
94-
|-- home/
95-
| |-- views.py # APP Views
96-
| |-- urls.py # APP Routing
97-
| |-- models.py # APP Models
98-
| |-- tests.py # Tests
99-
|
100-
|-- templates/
101-
| |-- includes/ # UI components
102-
| |-- layouts/ # Masterpages
103-
| |-- pages/ # Kit pages
104-
|
105-
|-- static/
106-
| |-- css/ # CSS Files
107-
| |-- scss/ # SCSS Files
108-
| |-- soft-ui-dashboard/_variables.scss # File Used for Theme Styling
109-
|
110-
|-- requirements.txt # Project Dependencies
111-
|
112-
|-- env.sample # ENV Configuration (default values)
113-
|-- manage.py # Start the app - Django default start script
114-
|
115-
|-- ************************************************************************
116-
```
117-
118-
<br />
119-
120-
## Recompile SCSS
121-
122-
The SCSS/CSS files used to style the Ui are saved in the `static` directory.
123-
In order to update the Ui colors (primary, secondary) this procedure needs to be followed.
124-
125-
```bash
126-
$ yarn # install modules
127-
$ vi static/scss/soft-ui-dashboard/_variables.scss # edit variables
128-
$ gulp # SCSS to CSS translation
129-
```
130-
131-
The `_variables.scss` content defines the `primary` and `secondary` colors:
132-
133-
```scss
134-
$primary: #cb0c9f !default; // EDIT for customization
135-
$secondary: #8392AB !default; // EDIT for customization
136-
$info: #17c1e8 !default; // EDIT for customization
137-
$success: #82d616 !default; // EDIT for customization
138-
$warning: #fbcf33 !default; // EDIT for customization
139-
$danger: #ea0606 !default; // EDIT for customization
140-
```
27+
![Django Soft Dashboard - Template project for Django provided by AppSeed.](https://user-images.githubusercontent.com/51070104/215729207-5cce250e-54da-4712-89a9-c1fd6b0a149e.png)
14128

14229
<br />
14330

144-
## Deploy on [Render](https://render.com/)
31+
## [Soft Dashboard PRO Version](https://app-generator.dev/product/soft-ui-dashboard-pro/django/)
14532

146-
- Create a Blueprint instance
147-
- Go to https://dashboard.render.com/blueprints this link.
148-
- Click `New Blueprint Instance` button.
149-
- Connect your `repo` which you want to deploy.
150-
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
151-
- After that your deployment will start automatically.
152-
153-
At this point, the product should be LIVE.
154-
155-
<br />
33+
> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-soft-dash-pro.onrender.com/).
15634
157-
## [Django Soft Dashboard](https://appseed.us/product/soft-ui-dashboard-pro/django/) `PRO`
158-
159-
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design concept. `Soft UI 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.
160-
161-
> Features:
162-
163-
- `Up-to-date Dependencies`
164-
- `Design`: [Django Theme Soft PRO](https://github.com/app-generator/django-admin-soft-pro) - `PRO Version`
165-
- `Sections` covered by the design:
166-
- **Admin section** (reserved for superusers)
167-
- **Authentication**: `Django.contrib.AUTH`, Registration
168-
- **All Pages** available in for ordinary users
169-
- `Docker`, `Deployment`:
170-
- `CI/CD` flow via `Render`
171-
172-
<br />
35+
- **Simple, Easy-to-Extend** Codebase
36+
- **Soft UI 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
17344

174-
![Soft UI Dashboard Pro](https://user-images.githubusercontent.com/51070104/211278814-881e0fcf-7986-4386-afee-540aa0f53bba.png)
45+
![Soft Dashboard PRO Django](https://github.com/user-attachments/assets/d49ff612-c7a6-418a-bf26-8479f8514f53)
17546

17647
<br />
17748

17849
---
179-
[Django Soft Dashboard](https://appseed.us/product/soft-ui-dashboard/django/) - **Django** starter provided by **[AppSeed](https://appseed.us/)**
50+
[Django Soft Dashboard](https://app-generator.dev/product/soft-ui-dashboard/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev)

0 commit comments

Comments
 (0)