Skip to content

Commit ce44e01

Browse files
author
App Generator
committed
Release v1.0.0
1 parent 2787d2d commit ce44e01

File tree

3 files changed

+315
-1
lines changed

3 files changed

+315
-1
lines changed

‎CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
3+
## [1.0.0] 2021-12-26
4+
### Initial release
5+
6+
- UI Version: `Soft UI Design PRO` **v1.0.8**
7+
- Codebase: [Django Boilerplate](https://github.com/app-generator/boilerplate-code-django) v1.0.7

‎LICENSE.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Commercial License
2+
3+
Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
4+
5+
<br />
6+
7+
## Licensing Information
8+
9+
<br />
10+
11+
### [Personal License](https://github.com/app-generator/license-personal)
12+
13+
> For full information please access [Personal License](https://github.com/app-generator/license-personal)
14+
15+
- Solo-developers, Small Teams: Up to 3
16+
- Updates: 6mo.
17+
- LIVE Support: 6mo.
18+
- Create single personal website/app
19+
- Create single website/app for client
20+
- Paying end-users - YES
21+
- Create SaaS application - NO
22+
- Production deployment assistance - NO
23+
24+
<br />
25+
26+
### [StartUP License](https://github.com/app-generator/license-startup)
27+
28+
> For full information please access [StartUP License](https://github.com/app-generator/license-startup)
29+
30+
- Medium teams: Up to 9
31+
- Updates: 12mo.
32+
- LIVE Support: 12mo.
33+
- Create single personal website/app
34+
- Create single website/app for client
35+
- Paying end-users - YES
36+
- Create SaaS application - NO
37+
- Production deployment assistance - NO
38+
39+
<br />
40+
41+
### [Company License](https://github.com/app-generator/license-company)
42+
43+
> For full information please access [Company License](https://github.com/app-generator/license-company)
44+
45+
- Large teams (unlimited members)
46+
- Updates: 12mo.
47+
- LIVE Support: 12mo.
48+
- Create multiple personal websites/apps
49+
- Create multiple websites/apps for clients
50+
- Paying end-users - YES
51+
- Create SINGLE SaaS application - YES
52+
- Production deployment assistance - NO
53+
54+
<br />
55+
56+
---
57+
For more information regarding licensing, contact the support < *support@appseed.us* >

‎README.md

Lines changed: 251 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,251 @@
1-
# django-soft-ui-design-pro
1+
# [Soft UI Design PRO Django](https://appseed.us/product/django-soft-ui-design-pro)
2+
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.
4+
5+
<br />
6+
7+
> Features
8+
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).
16+
17+
<br />
18+
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
23+
24+
<br />
25+
26+
## ✨ Quick Start in `Docker`
27+
28+
> Download the sources from the product page and `unzip` the archive
29+
30+
```bash
31+
$ unzip django-soft-ui-design-pro.zip
32+
$ cd django-soft-ui-design-pro
33+
```
34+
35+
> Start the app in Docker
36+
37+
```bash
38+
$ docker-compose up --build
39+
```
40+
41+
Visit `http://localhost:85` in your browser. The app should be up & running.
42+
43+
<br />
44+
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)
46+
47+
<br />
48+
49+
## ✨ How to use it
50+
> Download the sources from the product page and `unzip` the archive
51+
52+
```bash
53+
$ unzip django-soft-ui-design-pro.zip
54+
$ cd django-soft-ui-design-pro
55+
```
56+
57+
> Compile sources
58+
59+
```bash
60+
$ virtualenv env
61+
$ 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
68+
$ pip3 install -r requirements.txt
69+
$
70+
$ # Create tables
71+
$ python manage.py makemigrations
72+
$ 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/
81+
```
82+
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.
84+
85+
<br />
86+
87+
## ✨ Code-base structure
88+
89+
The project is coded using a simple and intuitive structure presented bellow:
90+
91+
```bash
92+
< PROJECT ROOT >
93+
|
94+
|-- core/ # Implements app configuration
95+
| |-- settings.py # Defines Global Settings
96+
| |-- wsgi.py # Start the app in production
97+
| |-- urls.py # Define URLs served by all apps/nodes
98+
|
99+
|-- apps/
100+
| |
101+
| |-- home/ # A simple app that serve HTML files
102+
| | |-- views.py # Serve HTML pages for authenticated users
103+
| | |-- urls.py # Define some super simple routes
104+
| |
105+
| |-- authentication/ # Handles auth routes (login and register)
106+
| | |-- urls.py # Define authentication routes
107+
| | |-- views.py # Handles login and registration
108+
| | |-- forms.py # Define auth forms (login and register)
109+
| |
110+
| |-- static/
111+
| | |-- <css, JS, images> # CSS files, Javascripts files
112+
| |
113+
| |-- templates/ # Templates used to render pages
114+
| |-- includes/ # HTML chunks and components
115+
| | |-- navigation.html # Top menu component
116+
| | |-- sidebar.html # Sidebar component
117+
| | |-- footer.html # App Footer
118+
| | |-- scripts.html # Scripts common to all pages
119+
| |
120+
| |-- layouts/ # Master pages
121+
| | |-- base-fullscreen.html # Used by Authentication pages
122+
| | |-- base.html # Used by common pages
123+
| |
124+
| |-- accounts/ # Authentication pages
125+
| | |-- login.html # Login page
126+
| | |-- register.html # Register page
127+
| |
128+
| |-- home/ # UI Kit Pages
129+
| |-- index.html # Index page
130+
| |-- 404-page.html # 404 page
131+
| |-- *.html # All other pages
132+
|
133+
|-- requirements.txt # Development modules - SQLite storage
134+
|
135+
|-- .env # Inject Configuration via Environment
136+
|-- manage.py # Start the app - Django default start script
137+
|
138+
|-- ************************************************************************
139+
```
140+
141+
<br />
142+
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
247+
248+
<br />
249+
250+
---
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).

0 commit comments

Comments
 (0)