Skip to content

Commit 246b0c7

Browse files
app-generatorapp-generator
committed
v1.0.17 - Udare RM Links -> APP-GENERATOR
1 parent 6afb9e1 commit 246b0c7

File tree

4 files changed

+50
-179
lines changed

4 files changed

+50
-179
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ apps/static/assets/node_modules
3131
apps/static/assets/yarn.lock
3232
apps/static/assets/.temp
3333

34+
README_bk.md

‎CHANGELOG.md

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

3+
## [1.0.17] 2025-03-13
4+
### Changes
5+
6+
- Update Product Links to [App-Generator](https://app-generator.dev/) Service
7+
- [Flask Material Kit](https://app-generator.dev/product/material-kit/flask/) - `Product Page`
8+
- [Flask Material Kit](https://flask-material-kit.appseed-srv1.com/) - `LIVE Demo`
9+
- [Flask Material Kit](https://app-generator.dev/docs/products/flask/material-kit/index.html) - `Complete Information` and Support Links
10+
311
## [1.0.16] 2024-11-21
412
### Changes
513

‎README.md

Lines changed: 39 additions & 179 deletions
Original file line numberDiff line numberDiff line change
@@ -1,199 +1,59 @@
1-
# [Flask Material Kit](https://appseed.us/product/material-kit/flask/)
1+
# [Flask Material Kit](https://app-generator.dev/product/material-kit/flask/)
22

3-
`Open-Source` **[Flask App](https://appseed.us/apps/flask/)** crafted on top of a modern **Bootstrap 5** UI. Designed for those who like bold elements and beautiful websites, **Material Kit 2** is ready to help you create stunning websites and web apps. `Material Kit 2` is built with over 60 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
3+
Open-source **Flask Starter with Material Kit Design**, an open-source iconic `Bootstrap` design.
4+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
45

5-
- 👉 [Flask Material Kit](https://appseed.us/product/material-kit/flask/) - product page
6-
- 👉 [Flask Material Kit](https://flask-material-kit.appseed-srv1.com/) - LIVE App
7-
8-
![Material Kit - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)
9-
10-
<br />
11-
12-
## Deploy on `Render` (free plan)
13-
14-
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
15-
16-
<br />
17-
18-
## Start with `Docker`
19-
20-
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
21-
22-
```bash
23-
$ git clone https://github.com/app-generator/flask-material-kit.git
24-
$ cd flask-material-kit
25-
```
26-
27-
<br />
28-
29-
> 👉 **Step 2** - Start the APP in `Docker`
30-
31-
```bash
32-
$ docker-compose up --build
33-
```
34-
35-
Visit `http://localhost:5085` in your browser. The app should be up & running.
36-
37-
<br />
38-
39-
## ✨ How to use it
40-
41-
> Download the code
42-
43-
```bash
44-
$ git clone https://github.com/app-generator/flask-material-kit.git
45-
$ cd flask-material-kit
46-
```
47-
48-
<br />
49-
50-
### 👉 Set Up for `Unix`, `MacOS`
51-
52-
> Install modules via `VENV`
53-
54-
```bash
55-
$ virtualenv env
56-
$ source env/bin/activate
57-
$ pip3 install -r requirements.txt
58-
```
59-
60-
<br />
61-
62-
> Set Up Flask Environment
63-
64-
```bash
65-
$ export FLASK_APP=run.py
66-
$ export FLASK_DEBUG=True
67-
```
68-
69-
<br />
70-
71-
> Start the app
72-
73-
```bash
74-
$ flask run
75-
```
76-
77-
At this point, the app runs at `http://127.0.0.1:5000/`.
78-
79-
<br />
80-
81-
### 👉 Set Up for `Windows`
82-
83-
> Install modules via `VENV` (windows)
84-
85-
```
86-
$ virtualenv env
87-
$ .\env\Scripts\activate
88-
$ pip3 install -r requirements.txt
89-
```
90-
91-
<br />
92-
93-
> Set Up Flask Environment
94-
95-
```bash
96-
$ # CMD
97-
$ set FLASK_APP=run.py
98-
$ set FLASK_DEBUG=True
99-
$
100-
$ # Powershell
101-
$ $env:FLASK_APP = ".\run.py"
102-
$ $env:FLASK_DEBUG = "True"
103-
```
104-
105-
<br />
106-
107-
> Start the app
108-
109-
```bash
110-
$ flask run
111-
```
112-
113-
At this point, the app runs at `http://127.0.0.1:5000/`.
6+
- 👉 [Flask Material Kit](https://app-generator.dev/product/material-kit/flask/) - `Product Page`
7+
- 👉 [Flask Material Kit](https://flask-material-kit.appseed-srv1.com/) - `LIVE Demo`
8+
- 👉 [Flask Material Kit](https://app-generator.dev/docs/products/flask/material-kit/index.html) - `Complete Information` and Support Links
9+
- [Getting Started with Flask](https://app-generator.dev/docs/technologies/flask/index.html) - a `comprehensive tutorial`
10+
- `Configuration`: Install Tailwind/Flowbite, Prepare Environment, Setting up the Database
11+
- `Start with Docker`
12+
- `Manual Build`
13+
- `Start the project`
14+
- `Deploy on Render`
11415

11516
<br />
11617

117-
### 👉 Create Users
18+
### Customize with [Flask App Generator](https://app-generator.dev/tools/flask-generator/)
11819

119-
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
20+
- Access the [App Generator](https://app-generator.dev/tools/flask-generator/) page
21+
- Select the preferred design
22+
- (Optional) Design Database: edit models and fields
23+
- (Optional) Edit the fields for the extended user model
24+
- (Optional) Enable OAuth for GitHub
25+
- (Optional) Add Celery (async tasks)
26+
- (Optional) Enable Dynamic Tables Module
27+
- Docker Scripts
28+
- Render CI/Cd Scripts
12029

121-
- Start the app via `flask run`
122-
- Access the `registration` page and create a new user:
123-
- `http://127.0.0.1:5000/register`
124-
- Access the `sign in` page and authenticate
125-
- `http://127.0.0.1:5000/login`
30+
**The generated Flask project is available as a ZIP Archive and also uploaded to GitHub.**
12631

12732
<br />
12833

129-
## Codebase structure
130-
131-
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
34+
## Deploy on `Render` (free plan)
13235

133-
```bash
134-
< PROJECT ROOT >
135-
|
136-
|-- apps/
137-
| |
138-
| |-- home/ # A simple app that serve HTML files
139-
| | |-- routes.py # Define app routes
140-
| |
141-
| |-- authentication/ # Handles auth routes (login and register)
142-
| | |-- routes.py # Define authentication routes
143-
| | |-- models.py # Defines models
144-
| | |-- forms.py # Define auth forms (login and register)
145-
| |
146-
| |-- static/
147-
| | |-- <css, JS, images> # CSS files, Javascripts files
148-
| |
149-
| |-- templates/ # Templates used to render pages
150-
| | |-- includes/ # HTML chunks and components
151-
| | | |-- navigation.html # Top menu component
152-
| | | |-- sidebar.html # Sidebar component
153-
| | | |-- footer.html # App Footer
154-
| | | |-- scripts.html # Scripts common to all pages
155-
| | |
156-
| | |-- layouts/ # Master pages
157-
| | | |-- base-fullscreen.html # Used by Authentication pages
158-
| | | |-- base.html # Used by common pages
159-
| | |
160-
| | |-- accounts/ # Authentication pages
161-
| | | |-- login.html # Login page
162-
| | | |-- register.html # Register page
163-
| | |
164-
| | |-- home/ # UI Kit Pages
165-
| | |-- index.html # Index page
166-
| | |-- 404-page.html # 404 page
167-
| | |-- *.html # All other pages
168-
| |
169-
| config.py # Set up the app
170-
| __init__.py # Initialize the app
171-
|
172-
|-- requirements.txt # App Dependencies
173-
|
174-
|-- .env # Inject Configuration via Environment
175-
|-- run.py # Start the app - WSGI gateway
176-
|
177-
|-- ************************************************************************
178-
```
36+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
17937

18038
<br />
18139

182-
## [Flask Material Kit](https://appseed.us/product/material-kit2-pro/flask/) `PRO`
183-
184-
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
40+
## Features
18541

186-
**Material Kit 2** 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.
42+
- Simple, Easy-to-Extend codebase, [Blueprint Pattern](https://app-generator.dev/blog/flask-blueprints-a-developers-guide/)
43+
- Up-to-date Dependencies
44+
- [Material Kit](https://app-generator.dev/docs/templates/bootstrap/material-kit.html) Full Integration
45+
- [Bootstrap](https://app-generator.dev/docs/templates/bootstrap/index.html) 5 Styling
46+
- Auth: Session Based, GitHub, Google
47+
- Celery Beat
48+
- DB Persistence: SQLite (default),
49+
- Easy switch to MySql/MariaDB, PgSql
50+
- Dynamic DataTables - manage data without coding
51+
- CI/CD integration for [Render](https://app-generator.dev/docs/deployment/render/index.html)
52+
- Deployment: Docker, Flask-Minify
18753

188-
- 👉 [Flask Material Kit2 PRO](https://appseed.us/product/material-kit2-pro/flask/) - product page
189-
- ✅ `Enhanced UI` - more pages and components
190-
- ✅ `Priority` on support
191-
192-
<br >
193-
194-
![Mk2 PRO - Premium Seed project by AppSeed.](https://user-images.githubusercontent.com/51070104/168224733-b054bb46-d454-4aea-bb94-2d01bf4760d2.png)
54+
![Material Kit - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)
19555

19656
<br />
19757

19858
---
199-
[Flask Material Kit](https://appseed.us/product/material-kit/flask/) - Open-source Flask Starter provided by **[App Generator](https://app-generator.dev/)**.
59+
[Flask Material Kit](https://app-generator.dev/product/material-kit/flask/) - Open-Source **Flask** Starter provided by [App Generator](https://app-generator.dev)

‎requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ flask_wtf==1.2.1
88
flask_sqlalchemy==3.1.1
99
sqlalchemy==2.0.36
1010
email_validator==2.2.0
11+
1112
gunicorn==23.0.0
1213
flask-restx==1.3.0
14+
1315
python-dotenv==1.0.1
1416
Flask-Minify==0.48
1517

0 commit comments

Comments
 (0)