Skip to content

Commit 659a037

Browse files
app-generatorapp-generator
committed
v1.0.8 - RM upadte for App-Generator Platform
1 parent 83995d7 commit 659a037

File tree

3 files changed

+54
-174
lines changed

3 files changed

+54
-174
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ apps/static/assets/.temp
3333

3434
.env__
3535

36+
README_bk.md

‎CHANGELOG.md‎

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

3+
## [1.0.8] 2025-03-06
4+
### Changes
5+
6+
Update RM for [App-Generator](https://app-generator.dev/) Platform
7+
- Update RM - Added [Flask App Generator](https://app-generator.dev/tools/flask-generator/) Link
8+
- Select the preferred design
9+
- (Optional) Design Database: edit models and fields
10+
- (Optional) Edit the fields for the extended user model
11+
- (Optional) Enable OAuth for GitHub
12+
- (Optional) Add Celery (async tasks)
13+
- (Optional) Enable Dynamic Tables Module
14+
- Docker Scripts
15+
- Render CI/Cd Scripts
16+
317
## [1.0.7] 2024-03-06
418
### Changes
519

‎README.md‎

Lines changed: 39 additions & 174 deletions
Original file line numberDiff line numberDiff line change
@@ -1,197 +1,62 @@
1-
# [Flask Berry Bootstrap 5](https://appseed.us/product/berry-dashboard/flask/)
1+
# [Flask Berry Dashboard](https://app-generator.dev/product/berry-dashboard/flask/)
22

3-
Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** project crafted on top of **Berry**, an open-source `Bootstrap 5` design from `CodedThemes`.
4-
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. `Berry` has an easy and intuitive responsive design whether it is viewed on retina screens or laptops.
3+
Open-source **Flask** project crafted on top of **Berry Dashboard Dashboard**, an open-source `Bootstrap` design.
4+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
55

6-
- 👉 [Flask Berry](https://appseed.us/product/berry-dashboard/flask/) - `Product page`
7-
- 👉 [Flask Berry](https://flask-berry.onrender.com) - `LIVE Demo`
6+
- 👉 [Flask Berry Dashboard](https://app-generator.dev/product/berry-dashboard/flask/) - `Product Page`
7+
- 👉 [Flask Berry Dashboard](https://flask-berry.onrender.com) - `LIVE Demo`
8+
- 👉 [Flask Berry Dashboard Documentation](https://app-generator.dev/docs/products/flask/berry-dashboard/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`
815

916
<br />
1017

1118
## Features
1219

13-
> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed**
20+
- Simple, Easy-to-Extend codebase, [Blueprint Pattern](https://app-generator.dev/blog/flask-blueprints-a-developers-guide/)
21+
- Up-to-date Dependencies
22+
- [Berry Dashboard](https://app-generator.dev/docs/templates/bootstrap/berry-dashboard.html) Full Integration
23+
- [Bootstrap](https://app-generator.dev/docs/templates/bootstrap/index.html) 5 Styling
24+
- DB Persistence: SQLite (default),
25+
- Easy switch to MySql/MariaDB, PgSql
26+
- CI/CD integration for [Render](https://app-generator.dev/docs/deployment/render/index.html)
27+
- Deployment: Docker, Flask-Minify
1428

15-
| Free Version | [PRO Version](https://appseed.us/product/berry-dashboard-pro/flask/) | [Custom Development](https://appseed.us/custom-development/) |
16-
| --------------------------------------| --------------------------------------| --------------------------------------|
17-
| ✓ **Up-to-date dependencies** | **Everything in Free**, plus: | **Everything in PRO**, plus: |
18-
| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1mo Custom Development** |
19-
| ✓ DB: SQLite, MySql | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/) | ✅ **Team**: PM, Developer, Tester |
20-
| ✓ DB Tools: ORM, Flask-Migrate | ✅ `Private REPO Access` | ✅ Weekly Sprints |
21-
| ✓ Session-Based authentication | - | ✅ Technical SPECS |
22-
| ✓ `Docker` | - | ✅ Documentation |
23-
| ✓ `CI/CD` Flow via Render | - | ✅ **30 days Delivery Warranty** |
24-
| ✓ `Free Support` | - | - |
25-
| --------------------------------- | --------------------------------- | --------------------------------- |
26-
| ✓ [LIVE Demo](https://flask-berry.onrender.com) | 🚀 [LIVE Demo](https://flask-berry-pro.onrender.com) `PRO` | 🛒 `Order`: **[$3,999](https://appseed.gumroad.com/l/rocket-package)** (GUMROAD) |
29+
![Flask Berry Dashboard - Open-Source Flask Starter](https://github.com/user-attachments/assets/71c3fed0-58cb-41e6-aa97-8686a10ede45)
2730

28-
![Berry Bootstrap 5 - Dark-Mode ready, Open-source Template.](https://user-images.githubusercontent.com/51070104/207091062-e805b36c-663a-4a01-acb8-9c55ab914f4f.jpg)
29-
30-
<br />
31-
32-
## ✨ Start the app in Docker
33-
34-
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
35-
36-
```bash
37-
$ git clone https://github.com/app-generator/flask-berry-dashboard.git
38-
$ cd flask-berry-dashboard
39-
```
40-
41-
<br />
42-
43-
> 👉 **Step 2** - Start the APP in `Docker`
44-
45-
```bash
46-
$ docker-compose up --build
47-
```
48-
49-
Visit `http://localhost:5085` in your browser. The app should be up & running.
50-
51-
<br />
52-
53-
## ✨ How to use it
54-
55-
> Download the code
56-
57-
```bash
58-
$ git clone https://github.com/app-generator/flask-berry-dashboard.git
59-
$ cd flask-berry-dashboard
60-
```
61-
62-
<br />
63-
64-
### 👉 Set Up for `Unix`, `MacOS`
65-
66-
> Install modules via `VENV`
67-
68-
```bash
69-
$ virtualenv env
70-
$ source env/bin/activate
71-
$ pip3 install -r requirements.txt
72-
```
73-
74-
<br />
75-
76-
> Set Up Flask Environment
77-
78-
Edit `.env` using `env.sample` or simply export the variables in the `environment`. Here are the expected values:
79-
80-
- `DEBUG`: controls the `Development`, `Production` mode
81-
- Default `False` (production)
82-
- `FLASK_APP=run.py`: mandatory (APP entry point)
83-
- `SECRET_KEY`: optional, random value used if not provided
84-
- `DB credentials`
85-
- `Note`: if NOT provided, or wrong values, **SQLite is used**
86-
- `DB_ENGINE`, `DB_HOST`, `DB_NAME` ...
87-
- `CDN_DOMAIN`: disabled by default
88-
- Used only when `DEBUG=False` (production mode)
89-
9031
<br />
9132

92-
> Start the app
33+
## Customize with [Flask Generator](https://app-generator.dev/tools/flask-generator/)
9334

94-
```bash
95-
$ flask run
96-
```
35+
- Access the [Flask Generator](https://app-generator.dev/tools/flask-generator/)
36+
- Select the preferred design
37+
- (Optional) Design Database: edit models and fields
38+
- (Optional) Edit the fields for the extended user model
39+
- (Optional) Enable OAuth for GitHub
40+
- (Optional) Add Celery (async tasks)
41+
- (Optional) Enable Dynamic Tables Module
42+
- Docker Scripts
43+
- Render CI/Cd Scripts
9744

98-
At this point, the app runs at `http://127.0.0.1:5000/`.
45+
**The generated Flask project is available as a ZIP Archive and also uploaded to GitHub.**
9946

100-
<br />
101-
102-
### 👉 Set Up for `Windows`
47+
![Flask Generator - Flask App Generator - User Interface for choosing the Design](https://github.com/user-attachments/assets/fbf73fc0-e9a1-4f01-86a8-aa8be55413b5)
10348

104-
> Install modules via `VENV` (windows)
105-
106-
```
107-
$ virtualenv env
108-
$ .\env\Scripts\activate
109-
$ pip3 install -r requirements.txt
110-
```
49+
![Flask App Generator - User Interface for Edit the Extended User Model](https://github.com/user-attachments/assets/138b9816-4f2e-454f-84f2-7409969b8548)
11150

11251
<br />
11352

114-
> Set Up Flask Environment
115-
116-
Edit `.env` using `env.sample` or simply export the variables in the `environment`. Here are the expected values:
117-
118-
- `DEBUG`: controls the `Development`, `Production` mode
119-
- Default `False` (production)
120-
- `FLASK_APP=run.py`: mandatory (APP entry point)
121-
- `SECRET_KEY`: optional, random value used if not provided
122-
- `DB credentials`
123-
- `Note`: if NOT provided, or wrong values, **SQLite is used**
124-
- `DB_ENGINE`, `DB_HOST`, `DB_NAME` ...
125-
- `CDN_DOMAIN`: disabled by default
126-
- Used only when `DEBUG=False` (production mode)
127-
128-
<br />
53+
## Deploy LIVE
12954

130-
> Start the app
55+
> One-click deploy (requires to have already an account).
13156
132-
```bash
133-
$ flask run
134-
```
135-
136-
At this point, the app runs at `http://127.0.0.1:5000/`.
137-
138-
<br />
139-
140-
## ✨ Code-base structure
141-
142-
The project has a simple, intuitive structure presented bellow:
143-
144-
```bash
145-
< PROJECT ROOT >
146-
|
147-
|-- apps/__init__.py
148-
|-- apps/
149-
| |-- static/
150-
| | |-- <css, JS, images> # CSS files, Javascripts files
151-
| |
152-
| |-- templates/
153-
| |
154-
| |-- includes/ # Page chunks, components
155-
| | |
156-
| | |-- navigation.html # Top bar
157-
| | |-- scripts.html # JS scripts common to all pages
158-
| | |-- footer.html # The common footer
159-
| |
160-
| |-- layouts/ # App Layouts (the master pages)
161-
| | |
162-
| | |-- base.html # Used by common pages like index, UI
163-
| |
164-
| |-- home/ # UI Kit Pages
165-
| |-- index.html # default page
166-
| |-- page-404.html # 404 error page
167-
| |-- *.html # Used by common pages like index, UI
168-
|
169-
|-- requirements.txt
170-
|
171-
|-- run.py
172-
|
173-
|-- ************************************************************************
174-
```
175-
176-
<br />
57+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
17758

178-
## Screenshots
179-
180-
![Berry Bootstrap 5 - Sign IN, Open-source Starter by AppSeed.](https://user-images.githubusercontent.com/51070104/207091198-2753246e-3d65-4aac-96de-0598a9a94788.jpg)
181-
182-
<br />
183-
184-
> [Flask Berry Bootstrap 5](https://github.com/app-generator/flask-berry-dashboard) - `Icons` Page
185-
186-
![Berry Bootstrap 5 - UI Icons page, Open-source Starter by AppSeed](https://user-images.githubusercontent.com/51070104/207091655-d5005e08-7ea0-4367-ab3a-2cd16934d2fd.jpg)
187-
188-
<br />
189-
190-
> [Flask Berry Bootstrap 5](https://github.com/app-generator/flask-berry-dashboard) - `Colors` page
191-
192-
![Berry Bootstrap 5 - Colors page, Open-source Starter by AppSeed](https://user-images.githubusercontent.com/51070104/207091441-942be542-2794-4bdb-a51d-85c75b5bc692.jpg)
193-
194-
<br />
59+
<br />
19560

19661
---
197-
[Flask Berry Bootstrap 5](https://appseed.us/product/berry-dashboard/flask/) - Minimal **Flask** starter provided by **[AppSeed](https://appseed.us/)**
62+
[Flask Berry Dashboard](https://app-generator.dev/product/berry-dashboard/flask/) - Open-Source **Flask** Starter provided by [App Generator](https://app-generator.dev)

0 commit comments

Comments
 (0)