Skip to content

Commit ec3498d

Browse files
app-generatorapp-generator
committed
Release v1.0.1
1 parent ce44e01 commit ec3498d

File tree

2 files changed

+128
-147
lines changed

2 files changed

+128
-147
lines changed

‎CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Change Log
22

3+
## [1.0.1] 2022-06-14
4+
### Improvements
5+
6+
- Built with [Soft UI Design PRO Generator](https://appseed.us/generator/soft-ui-design-pro/)
7+
- Timestamp: `2022-06-14 11:09`
8+
39
## [1.0.0] 2021-12-26
410
### Initial release
511

‎README.md

Lines changed: 122 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,173 @@
1-
# [Soft UI Design PRO Django](https://appseed.us/product/django-soft-ui-design-pro)
1+
# Soft UI Design PRO Django
2+
3+
**Django Web App** generated by `AppSeed` op top of a modern design. Designed for those who like bold elements and beautiful websites, **Soft UI Design PRO** is ready to help you create stunning websites and webapps.
4+
5+
- 👉 [Soft UI Design PRO Django](https://appseed.us/product/soft-ui-design-pro/django/) - Product page
6+
- 👉 [Soft UI Design PRO Django](https://django-soft-ui-design-pro.appseed-srv1.com/) - LIVE Demo
7+
- 👉 [Complete documentation](https://docs.appseed.us/products/django-apps/soft-ui-design-pro) - `Learn how to use and update the product`
8+
- ✅ [Set up the environment](https://docs.appseed.us/products/django-apps/soft-ui-design-pro#environment)
9+
- ✅ [Start the app in Docker](https://docs.appseed.us/products/django-apps/soft-ui-design-pro#start-the-app-in-docker)
10+
- ✅ [Manual Build](https://docs.appseed.us/products/django-apps/soft-ui-design-pro#manual-build)
11+
- ✅ [UI Assets and Templates](https://docs.appseed.us/products/django-apps/soft-ui-design-pro#ui-assets-and-templates)
12+
- ✅ [Set up the MySql Database](https://docs.appseed.us/products/django-apps/soft-ui-design-pro#set-up-the-mysql-database)
13+
- ✅ [Static Assets for production](https://docs.appseed.us/products/django-apps/soft-ui-design-pro#static-assets-for-production)
14+
15+
<br />
16+
17+
> Built with [Soft UI Design PRO Generator](https://appseed.us/generator/soft-ui-design-pro/)
218
3-
**Soft UI Design PRO** is a premium design crafted by the `Creative-Tim` agency on top of Bootstrap 5 Framework. Designed for those who like bold elements and beautiful websites, Material Kit 2 is made of hundreds of elements, designed blocks, and fully coded pages built with an impressive level of quality. The **Django** codebase provides the bare minimum essentials to start fast a new project.
19+
- Timestamp: `2022-06-14 11:09`
20+
- Build ID: `1972f361-176d-4c81-9673-559e03c127a0`
21+
- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
422

523
<br />
624

725
> Features
826
9-
- `Up-to-date dependencies`: **Django 3.2.6 LTS**
10-
- [SCSS compilation](#recompile-css) via **Gulp**
11-
- UI Kit: **Soft UI Design PRO** (Bootstrap 5 Version) by **Creative-Tim**
12-
- UI-Ready app, SQLite Database, Django Native ORM
13-
- Session-Based Authentication, Forms validation
14-
- `Deployment`: **Docker**, Gunicorn / Nginx
15-
- Support via **Github** and [Discord](https://discord.gg/fZC6hup).
27+
- `Up-to-date dependencies`
28+
- Database: `sqlite`
29+
- UI-Ready app, Django Native ORM
30+
- `Session-Based authentication`, Forms validation
1631

1732
<br />
1833

19-
> Links
20-
21-
- 👉 [Soft UI Design PRO Django](https://django-soft-ui-design-pro.appseed-srv1.com) - LIVE Demo
22-
- 👉 [Soft UI Design PRO Django](https://appseed.us/product/django-soft-ui-design-pro) - Product Page
34+
![Soft UI Design PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168812715-52e036b7-582d-4851-9657-6b1f99727619.png)
2335

2436
<br />
2537

26-
## ✨ Quick Start in `Docker`
38+
## ✨ Start the app in Docker
2739

28-
> Download the sources from the product page and `unzip` the archive
40+
> **Step 1** - Download the [code](https://appseed.us/product/soft-ui-design-pro/django/) and unzip the sources (requires a `purchase`).
2941
3042
```bash
43+
$ # Get the code
3144
$ unzip django-soft-ui-design-pro.zip
3245
$ cd django-soft-ui-design-pro
3346
```
3447

35-
> Start the app in Docker
48+
<br />
49+
50+
> **Step 2** - Edit `.env` and remove or comment all `DB_*` settings (`DB_ENGINE=...`). This will activate the `SQLite` persistance.
51+
52+
```txt
53+
DEBUG=True
54+
55+
# Deployment SERVER address
56+
SERVER=.appseed.us
57+
58+
# For MySql Persistence
59+
# DB_ENGINE=mysql <-- REMOVE or comment for Docker
60+
# DB_NAME=appseed_db <-- REMOVE or comment for Docker
61+
# DB_HOST=localhost <-- REMOVE or comment for Docker
62+
# DB_PORT=3306 <-- REMOVE or comment for Docker
63+
# DB_USERNAME=appseed_db_usr <-- REMOVE or comment for Docker
64+
# DB_PASS=<STRONG_PASS> <-- REMOVE or comment for Docker
65+
66+
```
67+
68+
<br />
69+
70+
> **Step 3** - Start the APP in `Docker`
3671
3772
```bash
3873
$ docker-compose up --build
3974
```
4075

41-
Visit `http://localhost:85` in your browser. The app should be up & running.
76+
Visit `http://localhost:5085` in your browser. The app should be up & running.
4277

4378
<br />
4479

45-
![Soft UI Design PRO Django - Seed project crafted by AppSeed and Creative-Tim.](https://user-images.githubusercontent.com/51070104/147412294-005356ae-9214-4b7f-83e9-fe0d6285c4b8.jpg)
4680

47-
<br />
4881

4982
## ✨ How to use it
50-
> Download the sources from the product page and `unzip` the archive
83+
84+
> Download the [code](https://appseed.us/product/soft-ui-design-pro/django/) and unzip the sources (requires a `purchase`).
5185
5286
```bash
87+
$ # Get the code
5388
$ unzip django-soft-ui-design-pro.zip
5489
$ cd django-soft-ui-design-pro
5590
```
5691

57-
> Compile sources
92+
<br />
93+
94+
### 👉 Set Up for `Unix`, `MacOS`
95+
96+
> Install modules via `VENV`
5897
5998
```bash
6099
$ virtualenv env
61100
$ source env/bin/activate
62-
$
63-
$ # Virtualenv modules installation (Windows based systems)
64-
$ # virtualenv env
65-
$ # .\env\Scripts\activate
66-
$
67-
$ # Install modules - SQLite Storage
68101
$ pip3 install -r requirements.txt
69-
$
70-
$ # Create tables
102+
```
103+
104+
<br />
105+
106+
> Set Up Database
107+
108+
```bash
109+
$ python manage.py makemigrations
110+
$ python manage.py migrate
111+
```
112+
113+
<br />
114+
115+
> Start the app
116+
117+
```bash
118+
$ python manage.py runserver
119+
```
120+
121+
At this point, the app runs at `http://127.0.0.1:8000/`.
122+
123+
<br />
124+
125+
### 👉 Set Up for `Windows`
126+
127+
> Install modules via `VENV` (windows)
128+
129+
```
130+
$ virtualenv env
131+
$ .\env\Scripts\activate
132+
$ pip3 install -r requirements.txt
133+
```
134+
135+
<br />
136+
137+
> Set Up Database
138+
139+
```bash
71140
$ python manage.py makemigrations
72141
$ python manage.py migrate
73-
$
74-
$ # Start the application (development mode)
75-
$ python manage.py runserver # default port 8000
76-
$
77-
$ # Start the app - custom port
78-
$ # python manage.py runserver 0.0.0.0:<your_port>
79-
$
80-
$ # Access the web app in browser: http://127.0.0.1:8000/
81142
```
82143

83-
> Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages.
144+
<br />
145+
146+
> Start the app
147+
148+
```bash
149+
$ python manage.py runserver
150+
```
151+
152+
At this point, the app runs at `http://127.0.0.1:8000/`.
153+
154+
<br />
155+
156+
## ✨ Create Users
157+
158+
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
159+
160+
- Start the app via `flask run`
161+
- Access the `registration` page and create a new user:
162+
- `http://127.0.0.1:8000/register/`
163+
- Access the `sign in` page and authenticate
164+
- `http://127.0.0.1:8000/login/`
84165

85166
<br />
86167

87168
## ✨ Code-base structure
88169

89-
The project is coded using a simple and intuitive structure presented bellow:
170+
The project is coded using a simple and intuitive structure presented below:
90171

91172
```bash
92173
< PROJECT ROOT >
@@ -118,7 +199,6 @@ The project is coded using a simple and intuitive structure presented bellow:
118199
| | |-- scripts.html # Scripts common to all pages
119200
| |
120201
| |-- layouts/ # Master pages
121-
| | |-- base-fullscreen.html # Used by Authentication pages
122202
| | |-- base.html # Used by common pages
123203
| |
124204
| |-- accounts/ # Authentication pages
@@ -127,7 +207,7 @@ The project is coded using a simple and intuitive structure presented bellow:
127207
| |
128208
| |-- home/ # UI Kit Pages
129209
| |-- index.html # Index page
130-
| |-- 404-page.html # 404 page
210+
| |-- page-404.html # 404 page
131211
| |-- *.html # All other pages
132212
|
133213
|-- requirements.txt # Development modules - SQLite storage
@@ -140,112 +220,7 @@ The project is coded using a simple and intuitive structure presented bellow:
140220

141221
<br />
142222

143-
> The bootstrap flow
144-
145-
- Django bootstrapper `manage.py` uses `core/settings.py` as the main configuration file
146-
- `core/settings.py` loads the app magic from `.env` file
147-
- Redirect the guest users to Login page
148-
- Unlock the pages served by *app* node for authenticated users
149-
150-
<br />
151-
152-
## ✨ Recompile CSS
153-
154-
To recompile SCSS files, follow this setup:
155-
156-
<br />
157-
158-
**Step #1** - Install tools
159-
160-
- [NodeJS](https://nodejs.org/en/) 12.x or higher
161-
- [Gulp](https://gulpjs.com/) - globally
162-
- `npm install -g gulp-cli`
163-
- [Yarn](https://yarnpkg.com/) (optional)
164-
165-
<br />
166-
167-
**Step #2** - Change the working directory to `assets` folder
168-
169-
```bash
170-
$ cd apps/static/assets
171-
```
172-
173-
<br />
174-
175-
**Step #3** - Install modules (this will create a classic `node_modules` directory)
176-
177-
```bash
178-
$ npm install
179-
// OR
180-
$ yarn
181-
```
182-
183-
<br />
184-
185-
**Step #4** - Edit & Recompile SCSS files
186-
187-
```bash
188-
$ gulp scss
189-
```
190-
191-
The generated file is saved in `static/assets/css` directory.
192-
193-
<br />
194-
195-
## ✨ Deployment
196-
197-
The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
198-
199-
### [Gunicorn](https://gunicorn.org/)
200-
---
201-
202-
Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.
203-
204-
> Install using pip
205-
206-
```bash
207-
$ pip install gunicorn
208-
```
209-
> Start the app using gunicorn binary
210-
211-
```bash
212-
$ gunicorn --bind=0.0.0.0:8001 core.wsgi:application
213-
Serving on http://localhost:8001
214-
```
215-
216-
Visit `http://localhost:8001` in your browser. The app should be up & running.
217-
218-
219-
<br />
220-
221-
### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/)
222-
---
223-
224-
Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.
225-
226-
> Install using pip
227-
228-
```bash
229-
$ pip install waitress
230-
```
231-
> Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html)
232-
233-
```bash
234-
$ waitress-serve --port=8001 core.wsgi:application
235-
Serving on http://localhost:8001
236-
```
237-
238-
Visit `http://localhost:8001` in your browser. The app should be up & running.
239-
240-
<br />
241-
242-
## ✨ Credits & Links
243-
244-
- [Django](https://www.djangoproject.com/) - The official website
245-
- [Boilerplate Code](https://appseed.us/boilerplate-code) - Index provided by **AppSeed**
246-
- [Boilerplate Code](https://github.com/app-generator/boilerplate-code) - Index published on Github
247223

248-
<br />
249224

250225
---
251-
[Soft UI Design PRO Django](https://appseed.us/product/django-soft-ui-design-pro) - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).
226+
Soft UI Design PRO Django - Seed project generated by **[AppSeed Generator](https://appseed.us/generator/)**.

0 commit comments

Comments
 (0)