Skip to content

Commit 1ef2c1d

Browse files
committed
Update README.md
1 parent 7d668db commit 1ef2c1d

File tree

1 file changed

+21
-33
lines changed

1 file changed

+21
-33
lines changed

README.md

Lines changed: 21 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,13 @@
22

33
Open-source **Django Dashboard** generated by `AppSeed` op top of a modern design. Designed for those who like bold elements and beautiful websites, **[Soft UI Dashboard](https://appseed.us/generator/soft-ui-dashboard/)** is ready to help you create stunning websites and webapps. **Soft UI Dashboard** is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
44

5-
<br />
6-
7-
> 🚀 Built with [Soft UI Dashboard Generator](https://appseed.us/generator/soft-ui-dashboard/), timestamp `2022-05-25 10:05`
8-
9-
- 👉 [Soft UI Dashboard Django](https://appseed.us/product/soft-ui-dashboard/django/) - Product page
10-
- 👉 [Soft UI Dashboard Django](https://django-soft-ui-dashboard.appseed-srv1.com/) - LIVE Demo
5+
- 👉 [Soft UI Dashboard Django](https://appseed.us/product/soft-ui-dashboard/django/) - `product page`
6+
- 👉 [Soft UI Dashboard Django](https://django-soft-ui-dashboard.appseed-srv1.com/) - `LIVE Demo`
117
- 👉 [Complete documentation](https://docs.appseed.us/products/django-dashboards/soft-ui-dashboard) - `Learn how to use and update the product`
12-
- 🚀 [Soft UI Dashboard PRO Django](https://appseed.us/product/soft-ui-dashboard-pro/django/) - `enhanced UI` and more `features`
13-
- `Authentication` - Social Login via `Github` & `Twitter`
14-
- Extended Users Profile
15-
- `Automatic users suspension` (on failed logins)
16-
- `Users Edit` for admins
17-
- `Change password`, `Self-Deletion`
188

199
<br />
2010

21-
> Features
11+
> Built with [App Generator](https://appseed.us/generator)
2212
2313
- `Up-to-date dependencies`
2414
- Database: `sqlite`
@@ -46,33 +36,27 @@ $ cd django-soft-ui-dashboard
4636

4737
<br />
4838

49-
> **Step 2** - Edit `.env` and remove or comment all `DB_*` settings (`DB_ENGINE=...`).
50-
51-
```txt
52-
DEBUG=True
53-
54-
# Deployment SERVER address
55-
SERVER=.appseed.us
56-
57-
# For MySql Persistence
58-
# DB_ENGINE=mysql <-- REMOVE or comment for Docker
59-
# DB_NAME=appseed_db <-- REMOVE or comment for Docker
60-
# DB_HOST=localhost <-- REMOVE or comment for Docker
61-
# DB_PORT=3306 <-- REMOVE or comment for Docker
62-
# DB_USERNAME=appseed_db_usr <-- REMOVE or comment for Docker
63-
# DB_PASS=<STRONG_PASS> <-- REMOVE or comment for Docker
39+
> **Step 2** - Start the APP in `Docker`
6440
41+
```bash
42+
$ docker-compose up --build
6543
```
6644

45+
Visit `http://localhost:5085` in your browser. The app should be up & running.
46+
6747
<br />
6848

69-
> **Step 3** - Start the APP in `Docker`
49+
## ✨ Create a new `.env` file using sample `env.sample`
7050

71-
```bash
72-
$ docker-compose up --build
73-
```
51+
The meaning of each variable can be found below:
7452

75-
Visit `http://localhost:5085` in your browser. The app should be up & running.
53+
- `DEBUG`: if `True` the app runs in develoment mode
54+
- For production value `False` should be used
55+
- `ASSETS_ROOT`: used in assets management
56+
- default value: `/static/assets`
57+
- `OAuth` via Github
58+
- `GITHUB_ID`=<GITHUB_ID_HERE>
59+
- `GITHUB_SECRET`=<GITHUB_SECRET_HERE>
7660

7761
<br />
7862

@@ -113,6 +97,8 @@ $ python manage.py migrate
11397
11498
```bash
11599
$ python manage.py runserver
100+
// OR with https
101+
$ python manage.py runsslserver
116102
```
117103

118104
At this point, the app runs at `http://127.0.0.1:8000/`.
@@ -144,6 +130,8 @@ $ python manage.py migrate
144130
145131
```bash
146132
$ python manage.py runserver
133+
// OR with https
134+
$ python manage.py runsslserver
147135
```
148136

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

0 commit comments

Comments
 (0)