Skip to content

Commit 47de399

Browse files
app-generatorapp-generator
committed
Release v2.0.1 - Bump codebase & UI Kit
1 parent be63b27 commit 47de399

File tree

335 files changed

+57666
-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.

335 files changed

+57666
-0
lines changed

‎.env

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
DEBUG=False
2+
FLASK_APP=run.py
3+
FLASK_ENV=development
4+
ASSETS_ROOT=/static/assets

‎.gitignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
flask/
2+
*.pyc
3+
dev
4+
node_modules
5+
app/database.db
6+
app/build
7+
yarn.lock
8+
yarn-error.log
9+
*.psd
10+
env/
11+
env__/
12+
.vscode/symbols.json
13+
app/db.sqlite3

‎CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Change Log
22

3+
## [2.0.1] 2022-06-08
4+
### Improvements
5+
6+
- Use generated version
7+
- UI kit: Material BS5 (free version)
8+
- Timestamp: `2022-06-08 05:44`
9+
- Build ID: `e7a6ed51-3614-4529-9538-0ca4a4145703`
10+
311
## [2.0.0] 2021-09-27
412
### Improvements
513

‎Dockerfile

+16
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

+32
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 < *[email protected]* >

‎README.md

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# Flask/jinja Boilerplate
2+
3+
> Experimental codebase `!!! Don't use it in production !!!`
4+
5+
<br />
6+
7+
> Built with [AppSeed Generator](https://appseed.us/generator/material-kit/)
8+
9+
- Timestamp: `2022-06-08 05:44`
10+
- Build ID: `e7a6ed51-3614-4529-9538-0ca4a4145703`
11+
- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
12+
13+
<br />
14+
15+
> Features
16+
17+
- `Up-to-date dependencies`
18+
- Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
19+
20+
<br />
21+
22+
![Material Kit - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)
23+
24+
<br />
25+
26+
27+
## ✨ Start the app in Docker
28+
29+
> **Step 1** - Download the code from the GH repository (using `GIT`)
30+
31+
```bash
32+
$ # Get the code
33+
$ git clone https://github.com/app-generator/boilerplate-code-flask.git
34+
$ cd boilerplate-code-flask
35+
```
36+
37+
<br />
38+
39+
> **Step 2** - Edit `.env` and set `DEBUG=True`. This will activate the `SQLite` persistance.
40+
41+
```txt
42+
DEBUG=True
43+
```
44+
45+
<br />
46+
47+
> **Step 3** - Start the APP in `Docker`
48+
49+
```bash
50+
$ docker-compose up --build
51+
```
52+
53+
Visit `http://localhost:5085` in your browser. The app should be up & running.
54+
55+
<br />
56+
57+
58+
## ✨ How to use it
59+
60+
> Download the code
61+
62+
```bash
63+
$ # Get the code
64+
$ git clone https://github.com/app-generator/boilerplate-code-flask.git
65+
$ cd boilerplate-code-flask
66+
```
67+
68+
<br />
69+
70+
### 👉 Set Up for `Unix`, `MacOS`
71+
72+
> Install modules via `VENV`
73+
74+
```bash
75+
$ virtualenv env
76+
$ source env/bin/activate
77+
$ pip3 install -r requirements.txt
78+
```
79+
80+
<br />
81+
82+
> Set Up Flask Environment
83+
84+
```bash
85+
$ export FLASK_APP=run.py
86+
$ export FLASK_ENV=development
87+
```
88+
89+
<br />
90+
91+
> Start the app
92+
93+
```bash
94+
$ flask run
95+
```
96+
97+
At this point, the app runs at `http://127.0.0.1:5000/`.
98+
99+
<br />
100+
101+
### 👉 Set Up for `Windows`
102+
103+
> Install modules via `VENV` (windows)
104+
105+
```
106+
$ virtualenv env
107+
$ .\env\Scripts\activate
108+
$ pip3 install -r requirements.txt
109+
```
110+
111+
<br />
112+
113+
> Set Up Flask Environment
114+
115+
```bash
116+
$ # CMD
117+
$ set FLASK_APP=run.py
118+
$ set FLASK_ENV=development
119+
$
120+
$ # Powershell
121+
$ $env:FLASK_APP = ".\run.py"
122+
$ $env:FLASK_ENV = "development"
123+
```
124+
125+
<br />
126+
127+
> Start the app
128+
129+
```bash
130+
$ flask run
131+
```
132+
133+
At this point, the app runs at `http://127.0.0.1:5000/`.
134+
135+
<br />
136+
137+
## ✨ Code-base structure
138+
139+
The project has a simple, intuitive structure presented bellow:
140+
141+
```bash
142+
< PROJECT ROOT >
143+
|
144+
|-- apps/__init__.py
145+
|-- apps/
146+
| |-- static/
147+
| | |-- <css, JS, images> # CSS files, Javascripts files
148+
| |
149+
| |-- templates/
150+
| |
151+
| |-- includes/ # Page chunks, components
152+
| | |
153+
| | |-- navigation.html # Top bar
154+
| | |-- scripts.html # JS scripts common to all pages
155+
| | |-- footer.html # The common footer
156+
| |
157+
| |-- layouts/ # App Layouts (the master pages)
158+
| | |
159+
| | |-- base.html # Used by common pages like index, UI
160+
| |
161+
| index.html # The default page
162+
| page-404.html # Error 404 page (page not found)
163+
| page-500.html # Error 500 page (server error)
164+
| *.html # All other pages provided by the UI Kit
165+
|
166+
|-- requirements.txt
167+
|
168+
|-- run.py
169+
|
170+
|-- ************************************************************************
171+
```
172+
173+
<br />
174+
175+
---
176+
Flask/jinja Boilerplate - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.

‎apps/__init__.py

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# -*- encoding: utf-8 -*-
2+
"""
3+
Copyright (c) 2019 - present AppSeed.us
4+
"""
5+
6+
import os
7+
8+
# import Flask
9+
from flask import Flask
10+
11+
from .config import Config
12+
13+
# Inject Flask magic
14+
app = Flask(__name__)
15+
16+
# load Configuration
17+
app.config.from_object( Config )
18+
19+
# Import routing to render the pages
20+
from apps import views

‎apps/config.py

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# -*- encoding: utf-8 -*-
2+
"""
3+
Copyright (c) 2019 - present AppSeed.us
4+
"""
5+
6+
import os
7+
8+
class Config(object):
9+
10+
basedir = os.path.abspath(os.path.dirname(__file__))
11+
12+
DEBUG = (os.getenv('DEBUG', 'False') == 'True')
13+
14+
# Assets Management
15+
ASSETS_ROOT = os.getenv('ASSETS_ROOT', '/static/assets')
16+
17+
# App Config - the minimal footprint
18+
SECRET_KEY = os.getenv('SECRET_KEY', 'S#perS3crEt_9999')

‎apps/static/assets/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)