Skip to content

Commit 040c451

Browse files
app-generatorapp-generator
committed
Release v1.0.6
1 parent 29a18fd commit 040c451

File tree

312 files changed

+50178
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

312 files changed

+50178
-0
lines changed

‎.dockerignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.git
2+
__pycache__
3+
*.pyc
4+
*.pyo
5+
*.pyd

‎.env

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
DEBUG=False
2+
FLASK_APP=run.py
3+
FLASK_ENV=development
4+
ASSETS_ROOT=/static/assets
5+
DB_ENGINE=mysql
6+
DB_HOST=localhost
7+
DB_NAME=appseed_db
8+
DB_USERNAME=appseed_db_usr
9+
DB_PASS=<STRONG_PASS_HERE>
10+
DB_PORT=3306

‎.gitignore

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
5+
# tests and coverage
6+
*.pytest_cache
7+
.coverage
8+
9+
# database & logs
10+
*.db
11+
*.sqlite3
12+
*.log
13+
14+
# venv
15+
env
16+
venv
17+
18+
# other
19+
.DS_Store
20+
21+
# sphinx docs
22+
_build
23+
_static
24+
_templates
25+
26+
# javascript
27+
package-lock.json
28+
.vscode/symbols.json
29+
30+
apps/static/assets/node_modules
31+
apps/static/assets/yarn.lock
32+
apps/static/assets/.temp
33+

‎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.6] 2022-05-31
4+
### Improvements
5+
6+
- Built with [Soft UI Design Generator](https://appseed.us/generator/soft-ui-design/)
7+
- Timestamp: `2022-05-31 08:48`
8+
39
## [1.0.5] 2022-01-17
410
### Improvements
511

‎Dockerfile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
FROM python:3.9
2+
3+
# set environment variables
4+
ENV PYTHONDONTWRITEBYTECODE 1
5+
ENV PYTHONUNBUFFERED 1
6+
7+
COPY requirements.txt .
8+
9+
# install python dependencies
10+
RUN pip install --upgrade pip
11+
RUN pip install --no-cache-dir -r requirements.txt
12+
13+
COPY . .
14+
15+
# gunicorn
16+
CMD ["gunicorn", "--config", "gunicorn-cfg.py", "run:app"]

‎LICENSE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# MIT License
2+
3+
Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
4+
5+
<br />
6+
7+
## Licensing Information
8+
9+
<br />
10+
11+
| Item | - |
12+
| ---------------------------------- | --- |
13+
| License Type | MIT |
14+
| Use for print | **YES** |
15+
| Create single personal website/app | **YES** |
16+
| Create single website/app for client | **YES** |
17+
| Create multiple website/apps for clients | **YES** |
18+
| Create multiple SaaS applications | **YES** |
19+
| End-product paying users | **YES** |
20+
| Product sale | **YES** |
21+
| Remove footer credits | **YES** |
22+
| --- | --- |
23+
| Remove copyright mentions from source code | NO |
24+
| Production deployment assistance | NO |
25+
| Create HTML/CSS template for sale | NO |
26+
| Create Theme/Template for CMS for sale | NO |
27+
| Separate sale of our UI Elements | NO |
28+
29+
<br />
30+
31+
---
32+
For more information regarding licensing, please contact the AppSeed Service < *support@appseed.us* >

‎README.md

Lines changed: 264 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,264 @@
1+
# [Soft UI Design](https://appseed.us/generator/soft-ui-design/) Flask
2+
3+
Open-source **Flask Web App** generated by `AppSeed` op top of a modern design. Designed for those who like bold elements and beautiful websites, **[Soft UI Design](https://appseed.us/generator/soft-ui-design/)** is ready to help you create stunning websites and webapps. **Soft UI Design** 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+
5+
- 👉 [Soft UI Design Flask](https://appseed.us/product/soft-ui-design/flask/) - Product page
6+
- 👉 [Soft UI Design Flask](https://flask-soft-ui-free.appseed-srv1.com/) - LIVE Demo
7+
8+
<br />
9+
10+
> Built with [Soft UI Design Generator](https://appseed.us/generator/soft-ui-design/)
11+
12+
- Timestamp: `2022-05-31 08:48`
13+
- Build ID: `01e9f6e7-15a8-42c7-9071-08ab6fefb4ce`
14+
- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
15+
16+
<br />
17+
18+
> Features
19+
20+
- `Up-to-date dependencies`
21+
- Database: `mysql`
22+
- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
23+
- Session-Based authentication (via **flask_login**), Forms validation
24+
25+
<br />
26+
27+
![Soft UI Design - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168812602-e35bad42-823f-4d3e-9d13-87a6c06c5a63.png)
28+
29+
<br />
30+
31+
32+
## ✨ Start the app in Docker
33+
34+
> **Step 1** - Download the code from the GH repository (using `GIT`)
35+
36+
```bash
37+
$ # Get the code
38+
$ git clone https://github.com/app-generator/flask-soft-ui-design.git
39+
$ cd flask-soft-ui-design
40+
```
41+
42+
<br />
43+
44+
> **Step 2** - Edit `.env` and set `DEBUG=True`. This will activate the `SQLite` persistance.
45+
46+
```txt
47+
DEBUG=True
48+
```
49+
50+
<br />
51+
52+
> **Step 3** - Start the APP in `Docker`
53+
54+
```bash
55+
$ docker-compose up --build
56+
```
57+
58+
Visit `http://localhost:5085` in your browser. The app should be up & running.
59+
60+
<br />
61+
62+
63+
64+
## ✨ Set up the MySql Database
65+
66+
**Note:** Make sure your Mysql server is properly installed and accessible.
67+
68+
> **Step 1** - Create the MySql Database to be used by the app
69+
70+
- `Create a new MySql` database
71+
- `Create a new user` and assign full privilegies (read/write)
72+
73+
<br />
74+
75+
> **Step 2** - Edit the `.env` to match your MySql DB credentials. Make sure `DB_ENGINE` is set to `mysql`.
76+
77+
- `DB_ENGINE` : `mysql`
78+
- `DB_NAME` : default value = `appseed_db`
79+
- `DB_HOST` : default value = `localhost`
80+
- `DB_PORT` : default value = `3306`
81+
- `DB_USERNAME`: default value = `appseed_db_usr`
82+
- `DB_PASS` : default value = `pass`
83+
84+
<br />
85+
86+
Here is a sample:
87+
88+
```txt
89+
# .env sample
90+
91+
DEBUG=False # False enables the MySql Persistence
92+
93+
DB_ENGINE=mysql # Database Driver
94+
DB_NAME=appseed_flask # Database Name
95+
DB_USERNAME=appseed_flask_usr # Database User
96+
DB_PASS=STRONG_PASS_HERE # Password
97+
DB_HOST=localhost # Database HOST, default is localhost
98+
DB_PORT=3306 # MySql port, default = 3306
99+
```
100+
101+
<br />
102+
103+
104+
## ✨ How to use it
105+
106+
> Download the code
107+
108+
```bash
109+
$ # Get the code
110+
$ git clone https://github.com/app-generator/flask-soft-ui-design.git
111+
$ cd flask-soft-ui-design
112+
```
113+
114+
<br />
115+
116+
### 👉 Set Up for `Unix`, `MacOS`
117+
118+
> Install modules via `VENV`
119+
120+
```bash
121+
$ virtualenv env
122+
$ source env/bin/activate
123+
$ pip3 install -r requirements.txt
124+
```
125+
126+
<br />
127+
128+
> Set Up Flask Environment
129+
130+
```bash
131+
$ export FLASK_APP=run.py
132+
$ export FLASK_ENV=development
133+
```
134+
135+
<br />
136+
137+
> Start the app
138+
139+
```bash
140+
$ flask run
141+
```
142+
143+
At this point, the app runs at `http://127.0.0.1:5000/`.
144+
145+
<br />
146+
147+
### 👉 Set Up for `Windows`
148+
149+
> Install modules via `VENV` (windows)
150+
151+
```
152+
$ virtualenv env
153+
$ .\env\Scripts\activate
154+
$ pip3 install -r requirements.txt
155+
```
156+
157+
<br />
158+
159+
> Set Up Flask Environment
160+
161+
```bash
162+
$ # CMD
163+
$ set FLASK_APP=run.py
164+
$ set FLASK_ENV=development
165+
$
166+
$ # Powershell
167+
$ $env:FLASK_APP = ".\run.py"
168+
$ $env:FLASK_ENV = "development"
169+
```
170+
171+
<br />
172+
173+
> Start the app
174+
175+
```bash
176+
$ flask run
177+
```
178+
179+
At this point, the app runs at `http://127.0.0.1:5000/`.
180+
181+
<br />
182+
183+
### 👉 Create Users
184+
185+
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
186+
187+
- Start the app via `flask run`
188+
- Access the `registration` page and create a new user:
189+
- `http://127.0.0.1:5000/register`
190+
- Access the `sign in` page and authenticate
191+
- `http://127.0.0.1:5000/login`
192+
193+
<br />
194+
195+
## ✨ Code-base structure
196+
197+
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
198+
199+
```bash
200+
< PROJECT ROOT >
201+
|
202+
|-- apps/
203+
| |
204+
| |-- home/ # A simple app that serve HTML files
205+
| | |-- routes.py # Define app routes
206+
| |
207+
| |-- authentication/ # Handles auth routes (login and register)
208+
| | |-- routes.py # Define authentication routes
209+
| | |-- models.py # Defines models
210+
| | |-- forms.py # Define auth forms (login and register)
211+
| |
212+
| |-- static/
213+
| | |-- <css, JS, images> # CSS files, Javascripts files
214+
| |
215+
| |-- templates/ # Templates used to render pages
216+
| | |-- includes/ # HTML chunks and components
217+
| | | |-- navigation.html # Top menu component
218+
| | | |-- sidebar.html # Sidebar component
219+
| | | |-- footer.html # App Footer
220+
| | | |-- scripts.html # Scripts common to all pages
221+
| | |
222+
| | |-- layouts/ # Master pages
223+
| | | |-- base-fullscreen.html # Used by Authentication pages
224+
| | | |-- base.html # Used by common pages
225+
| | |
226+
| | |-- accounts/ # Authentication pages
227+
| | | |-- login.html # Login page
228+
| | | |-- register.html # Register page
229+
| | |
230+
| | |-- home/ # UI Kit Pages
231+
| | |-- index.html # Index page
232+
| | |-- 404-page.html # 404 page
233+
| | |-- *.html # All other pages
234+
| |
235+
| config.py # Set up the app
236+
| __init__.py # Initialize the app
237+
|
238+
|-- requirements.txt # App Dependencies
239+
|
240+
|-- .env # Inject Configuration via Environment
241+
|-- run.py # Start the app - WSGI gateway
242+
|
243+
|-- ************************************************************************
244+
```
245+
246+
<br />
247+
248+
## ✨ PRO Version
249+
250+
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
251+
252+
Soft UI Design is a premium Bootstrap 5 Design now available for download in Flask. Made of hundred of elements, designed blocks, and fully coded pages, Soft UI Design PRO is ready to help you create stunning websites and web apps.
253+
254+
- 👉 [Soft UI Design PRO Flask](https://appseed.us/product/soft-ui-design-pro/flask/) - Product Page
255+
- 👉 [Soft UI Design PRO Flask](https://flask-soft-ui-design-pro.appseed-srv1.com/) - LIVE Demo
256+
257+
<br >
258+
259+
![Soft UI Design (PRO Version) - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168812715-52e036b7-582d-4851-9657-6b1f99727619.png)
260+
261+
<br />
262+
263+
---
264+
[Soft UI Design](https://appseed.us/generator/soft-ui-design/) Flask - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.

0 commit comments

Comments
 (0)