Skip to content

Commit be222e4

Browse files
app-generatorapp-generator
committed
v1.0.9 - Update RM (minor)
1 parent d8eab6f commit be222e4

File tree

3 files changed

+57
-173
lines changed

3 files changed

+57
-173
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: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Change Log
22

3+
## [1.0.9] 2025-04-01
4+
### Changes
5+
6+
- Update RM (minor)
7+
38
## [1.0.8] 2023-10-07
49
### Changes
510

‎README.md‎

Lines changed: 51 additions & 173 deletions
Original file line numberDiff line numberDiff line change
@@ -1,199 +1,77 @@
1-
# [CoreUI Flask](https://appseed.us/product/coreui/flask/)
1+
# [Flask CoreUI](https://app-generator.dev/product/coreui/flask/)
22

3-
Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** generated by `AppSeed` on top of an iconic design. For newcomers, **CoreUI** is one of the best open-source admin dashboard & control panel themes. Built on top of Bootstrap, `CoreUI` provides a range of responsive, reusable, and commonly used components.
4-
5-
- 👉 [CoreUI Flask](https://appseed.us/product/coreui/flask/) - product page
6-
- 👉 [CoreUI Flask](https://flask-coreui.appseed-srv1.com/) - LIVE Deployment
7-
8-
## ✅ Features
9-
10-
- `Up-to-date dependencies`
11-
- Database: `sqlite`
12-
- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
13-
- Session-Based authentication (via **flask_login**), Forms validation
14-
- `Docker`
15-
- CI/CD Flow via Render
16-
17-
![CoreUI Dashboard - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/171336361-b125ca1d-8936-4f4a-b662-9e45ee25f404.png)
18-
19-
<br />
20-
21-
## ✅ Start in `Docker`
22-
23-
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
24-
25-
```bash
26-
$ git clone https://github.com/app-generator/flask-coreui.git
27-
$ cd flask-coreui
28-
```
29-
30-
<br />
31-
32-
> 👉 **Step 2** - Start the APP in `Docker`
33-
34-
```bash
35-
$ docker-compose up --build
36-
```
37-
38-
Visit `http://localhost:5085` in your browser. The app should be up & running.
39-
40-
41-
## ✅ Manual Build
42-
43-
> Download the code
44-
45-
```bash
46-
$ git clone https://github.com/app-generator/flask-coreui.git
47-
$ cd flask-coreui
48-
```
49-
50-
<br />
51-
52-
### 👉 Set Up for `Unix`, `MacOS`
53-
54-
> Install modules via `VENV`
55-
56-
```bash
57-
$ virtualenv env
58-
$ source env/bin/activate
59-
$ pip3 install -r requirements.txt
60-
```
61-
62-
<br />
63-
64-
> Set Up Flask Environment
65-
66-
```bash
67-
$ export FLASK_APP=run.py
68-
$ export FLASK_ENV=development
69-
```
70-
71-
<br />
72-
73-
> Start the app
74-
75-
```bash
76-
$ flask run
77-
```
3+
Open-source **Flask Starter with CoreUI 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.
785

79-
At this point, the app runs at `http://127.0.0.1:5000/`.
6+
- 👉 [Flask CoreUI](https://app-generator.dev/product/coreui/flask/) - `Product Page`
7+
- 👉 [Flask CoreUI](https://flask-coreui.appseed-srv1.com/) - `LIVE Demo`
8+
- 👉 [Flask CoreUI](https://app-generator.dev/docs/products/flask/coreui/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`
8015

8116
<br />
8217

83-
### 👉 Set Up for `Windows`
18+
## Features
8419

85-
> Install modules via `VENV` (windows)
20+
- Simple, Easy-to-Extend codebase, [Blueprint Pattern](https://app-generator.dev/blog/flask-blueprints-a-developers-guide/)
21+
- [CoreUI](https://app-generator.dev/docs/templates/bootstrap/coreui.html) Full Integration
22+
- [Bootstrap](https://app-generator.dev/docs/templates/bootstrap/index.html) CSS Styling
23+
- Auth: Session Based, GitHub, Google
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
8628

87-
```
88-
$ virtualenv env
89-
$ .\env\Scripts\activate
90-
$ pip3 install -r requirements.txt
91-
```
29+
![CoreUI - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168842202-9b80a957-a375-4e6d-8247-2cc459267a86.png)
9230

9331
<br />
9432

95-
> Set Up Flask Environment
33+
## Deploy on `Render`
9634

97-
```bash
98-
$ # CMD
99-
$ set FLASK_APP=run.py
100-
$ set FLASK_ENV=development
101-
$
102-
$ # Powershell
103-
$ $env:FLASK_APP = ".\run.py"
104-
$ $env:FLASK_ENV = "development"
105-
```
35+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
10636

10737
<br />
10838

109-
> Start the app
39+
## [Datta Able PRO Version](https://app-generator.dev/product/datta-able-pro/flask/)
11040

111-
```bash
112-
$ flask run
113-
```
41+
> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://flask-datta-pro.onrender.com/).
11442
115-
At this point, the app runs at `http://127.0.0.1:5000/`.
43+
- **Simple, Easy-to-Extend** Codebase
44+
- **Berry PRO** Design - Bootstrap 5 Design
45+
- **Extended User Profiles**
46+
- [Charts](https://flask-datta-pro.onrender.com/charts/)
47+
- [DataTables](https://flask-datta-pro.onrender.com/tables): Server-side Pagination, Search, Filters, Export
48+
- API
49+
- **File Manager**
50+
- **Celery** (async tasks)
51+
- **Docker**
52+
- **Deployment-Ready** for Render
11653

117-
<br />
118-
119-
### 👉 Create Users
120-
121-
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
122-
123-
- Start the app via `flask run`
124-
- Access the `registration` page and create a new user:
125-
- `http://127.0.0.1:5000/register`
126-
- Access the `sign in` page and authenticate
127-
- `http://127.0.0.1:5000/login`
128-
129-
<br />
130-
131-
## ✅ Codebase
132-
133-
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
134-
135-
```bash
136-
< PROJECT ROOT >
137-
|
138-
|-- apps/
139-
| |
140-
| |-- home/ # A simple app that serve HTML files
141-
| | |-- routes.py # Define app routes
142-
| |
143-
| |-- authentication/ # Handles auth routes (login and register)
144-
| | |-- routes.py # Define authentication routes
145-
| | |-- models.py # Defines models
146-
| | |-- forms.py # Define auth forms (login and register)
147-
| |
148-
| |-- static/
149-
| | |-- <css, JS, images> # CSS files, Javascripts files
150-
| |
151-
| |-- templates/ # Templates used to render pages
152-
| | |-- includes/ # HTML chunks and components
153-
| | | |-- navigation.html # Top menu component
154-
| | | |-- sidebar.html # Sidebar component
155-
| | | |-- footer.html # App Footer
156-
| | | |-- scripts.html # Scripts common to all pages
157-
| | |
158-
| | |-- layouts/ # Master pages
159-
| | | |-- base-fullscreen.html # Used by Authentication pages
160-
| | | |-- base.html # Used by common pages
161-
| | |
162-
| | |-- accounts/ # Authentication pages
163-
| | | |-- login.html # Login page
164-
| | | |-- register.html # Register page
165-
| | |
166-
| | |-- home/ # UI Kit Pages
167-
| | |-- index.html # Index page
168-
| | |-- 404-page.html # 404 page
169-
| | |-- *.html # All other pages
170-
| |
171-
| config.py # Set up the app
172-
| __init__.py # Initialize the app
173-
|
174-
|-- requirements.txt # App Dependencies
175-
|
176-
|-- .env # Inject Configuration via Environment
177-
|-- run.py # Start the app - WSGI gateway
178-
|
179-
|-- ************************************************************************
180-
```
54+
![Datta Able PRO - Full-Stack Flask Starter provided by App-Generator.](https://user-images.githubusercontent.com/51070104/170474361-a58da82b-fff9-4a59-81a8-7ab99f478f48.png)
18155

18256
<br />
18357

184-
## ✅ [PRO Version](https://appseed.us/product/material-dashboard2-pro/flask/)
58+
## `Customize` with [Flask Generator](https://app-generator.dev/tools/flask-generator/)
18559

186-
> For more components, pages, and priority on support, feel free to take a look at this amazing starter:
60+
- Access the [Flask Generator](https://app-generator.dev/tools/flask-generator/)
61+
- Select the preferred design
62+
- (Optional) Design Database: edit models and fields
63+
- (Optional) Edit the fields for the extended user model
64+
- (Optional) Enable OAuth for GitHub
65+
- (Optional) Add Celery (async tasks)
66+
- (Optional) Enable Dynamic Tables Module
67+
- Docker Scripts
68+
- Render CI/Cd Scripts
18769

188-
**Flask** starter styled with **[Material Dashboard PRO](https://appseed.us/product/material-dashboard2-pro/flask/)**, a premium `Bootstrap 5` KIT from `Creative-Tim`.
189-
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
70+
**The generated Flask project is available as a ZIP Archive and also uploaded to GitHub.**
19071

191-
- 👉 [Flask Material 2 PRO](https://appseed.us/product/material-dashboard2-pro/flask/) - Product page
192-
- 👉 [Flask Material 2 PRO](https://flask-material-dashboard2-pro.appseed-srv1.com) - LIVE Demo
72+
![Flask Generator - Flask App Generator - User Interface for choosing the Design](https://github.com/user-attachments/assets/fbf73fc0-e9a1-4f01-86a8-aa8be55413b5)
19373

194-
![Flask Material Dash 2 PRO - Premium starter crafted by AppSeed and Creative-Tim.](https://user-images.githubusercontent.com/51070104/218248092-adf0dfe6-10bb-4665-aa89-dd6265d11995.png)
195-
196-
<br />
74+
![Flask App Generator - User Interface for Edit the Extended User Model](https://github.com/user-attachments/assets/138b9816-4f2e-454f-84f2-7409969b8548)
19775

19876
---
199-
[CoreUI Flask](https://appseed.us/product/coreui/flask/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.
77+
[Flask CoreUI](https://app-generator.dev/product/coreui/flask/) - Open-Source **Flask** Starter provided by [App Generator](https://app-generator.dev)

0 commit comments

Comments
 (0)