|
2 | 2 |
|
3 | 3 | 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. |
4 | 4 |
|
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` |
11 | 7 | - 👉 [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` |
18 | 8 |
|
19 | 9 | <br /> |
20 | 10 |
|
21 | | -> Features |
| 11 | +> Built with [App Generator](https://appseed.us/generator) |
22 | 12 |
|
23 | 13 | - `Up-to-date dependencies` |
24 | 14 | - Database: `sqlite` |
@@ -46,33 +36,27 @@ $ cd django-soft-ui-dashboard |
46 | 36 |
|
47 | 37 | <br /> |
48 | 38 |
|
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` |
64 | 40 |
|
| 41 | +```bash |
| 42 | +$ docker-compose up --build |
65 | 43 | ``` |
66 | 44 |
|
| 45 | +Visit `http://localhost:5085` in your browser. The app should be up & running. |
| 46 | + |
67 | 47 | <br /> |
68 | 48 |
|
69 | | -> **Step 3** - Start the APP in `Docker` |
| 49 | +## ✨ Create a new `.env` file using sample `env.sample` |
70 | 50 |
|
71 | | -```bash |
72 | | -$ docker-compose up --build |
73 | | -``` |
| 51 | +The meaning of each variable can be found below: |
74 | 52 |
|
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> |
76 | 60 |
|
77 | 61 | <br /> |
78 | 62 |
|
@@ -113,6 +97,8 @@ $ python manage.py migrate |
113 | 97 |
|
114 | 98 | ```bash |
115 | 99 | $ python manage.py runserver |
| 100 | +// OR with https |
| 101 | +$ python manage.py runsslserver |
116 | 102 | ``` |
117 | 103 |
|
118 | 104 | At this point, the app runs at `http://127.0.0.1:8000/`. |
@@ -144,6 +130,8 @@ $ python manage.py migrate |
144 | 130 |
|
145 | 131 | ```bash |
146 | 132 | $ python manage.py runserver |
| 133 | +// OR with https |
| 134 | +$ python manage.py runsslserver |
147 | 135 | ``` |
148 | 136 |
|
149 | 137 | At this point, the app runs at `http://127.0.0.1:8000/`. |
|
0 commit comments