Skip to content

Commit 87cd3e0

Browse files
app-generatorapp-generator
committed
v1.0.18 - Update RM links -> APP_GENERATOR
1 parent fe19449 commit 87cd3e0

File tree

3 files changed

+48
-195
lines changed

3 files changed

+48
-195
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.18] 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/pixel-bootstrap/flask/) - `Product Page`
8+
- [Flask Material Kit](https://flask-pixel-lite.appseed-srv1.com/) - `LIVE Demo`
9+
- [Flask Material Kit](https://app-generator.dev/docs/products/flask/pixel/index.html) - `Complete Information` and Support Links
10+
311
## [1.0.17] 2024-10-28
412
### Changes
513

‎README.md‎

Lines changed: 39 additions & 195 deletions
Original file line numberDiff line numberDiff line change
@@ -1,215 +1,59 @@
1-
# [Flask Pixel Lite](https://appseed.us/product/pixel-bootstrap/flask/)
1+
# [Flask Pixel UI Kit](https://app-generator.dev/product/pixel-bootstrap/flask/)
22

3-
`Open-Source` **[Flask App](https://appseed.us/apps/flask/)** crafted on top of a modern design. `Pixel` is a free and open-source `Bootstrap 5` UI Kit featuring over 80 fully coded UI elements and example pages that will help you prototype and build a website for your next project.
3+
Open-source **Flask Starter with Pixel UI 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 Pixel Lite](https://appseed.us/product/pixel-bootstrap/flask/) - product page
6-
- 👉 [Flask Pixel Lite](https://flask-pixel-lite.appseed-srv1.com/) - LIVE Deployment
7-
8-
![Pixel Bootstrap Lite - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168753915-d61b2f97-57b2-4d14-a774-d217d120ff62.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-pixel.git
24-
$ cd flask-pixel
25-
```
6+
- 👉 [Flask Material Kit](https://app-generator.dev/product/pixel-bootstrap/flask/) - `Product Page`
7+
- 👉 [Flask Material Kit](https://flask-pixel-lite.appseed-srv1.com/) - `LIVE Demo`
8+
- 👉 [Flask Material Kit](https://app-generator.dev/docs/products/flask/pixel/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`
2615

2716
<br />
2817

29-
> 👉 **Step 2** - Start the APP in `Docker`
30-
31-
```bash
32-
$ docker-compose up --build
33-
```
18+
### Customize with [Flask App Generator](https://app-generator.dev/tools/flask-generator/)
3419

35-
Visit `http://localhost:5085` in your browser. The app should be up & running.
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
3629

37-
<br />
38-
39-
## Manual Build
40-
41-
> Download the code
42-
43-
```bash
44-
$ git clone https://github.com/app-generator/flask-pixel.git
45-
$ cd flask-pixel
46-
```
30+
**The generated Flask project is available as a ZIP Archive and also uploaded to GitHub.**
4731

4832
<br />
4933

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/`.
114-
115-
<br />
116-
117-
### 👉 Create Users
118-
119-
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
120-
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`
126-
127-
<br />
128-
129-
## CSS/SCSS Update
130-
131-
In order to customize the UI (primary/seconday colors), follow this setup:
132-
133-
- Navigate to `apps/static/assets`
134-
- Edit SCSS files
135-
- Install dependencies using [PNPM](https://pnpm.io/)
136-
- `pnpm i`
137-
- Recompile the SCSS files with Gulp
138-
- `gulp`
139-
140-
> NOTE: the above setup was tested using:
141-
142-
- Node `v16.15.0`
143-
- Gulp CLI `2.3.0`, LOCAL `4.0.2`
144-
- PNPM `v8.6.0`
145-
146-
<br />
147-
148-
## Codebase Structure
149-
150-
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)
15135

152-
```bash
153-
< PROJECT ROOT >
154-
|
155-
|-- apps/
156-
| |
157-
| |-- home/ # A simple app that serve HTML files
158-
| | |-- routes.py # Define app routes
159-
| |
160-
| |-- authentication/ # Handles auth routes (login and register)
161-
| | |-- routes.py # Define authentication routes
162-
| | |-- models.py # Defines models
163-
| | |-- forms.py # Define auth forms (login and register)
164-
| |
165-
| |-- static/
166-
| | |-- <css, JS, images> # CSS files, Javascripts files
167-
| |
168-
| |-- templates/ # Templates used to render pages
169-
| | |-- includes/ # HTML chunks and components
170-
| | | |-- navigation.html # Top menu component
171-
| | | |-- sidebar.html # Sidebar component
172-
| | | |-- footer.html # App Footer
173-
| | | |-- scripts.html # Scripts common to all pages
174-
| | |
175-
| | |-- layouts/ # Master pages
176-
| | | |-- base-fullscreen.html # Used by Authentication pages
177-
| | | |-- base.html # Used by common pages
178-
| | |
179-
| | |-- accounts/ # Authentication pages
180-
| | | |-- login.html # Login page
181-
| | | |-- register.html # Register page
182-
| | |
183-
| | |-- home/ # UI Kit Pages
184-
| | |-- index.html # Index page
185-
| | |-- 404-page.html # 404 page
186-
| | |-- *.html # All other pages
187-
| |
188-
| config.py # Set up the app
189-
| __init__.py # Initialize the app
190-
|
191-
|-- requirements.txt # App Dependencies
192-
|
193-
|-- .env # Inject Configuration via Environment
194-
|-- run.py # Start the app - WSGI gateway
195-
|
196-
|-- ************************************************************************
197-
```
36+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
19837

19938
<br />
20039

201-
## PRO Version
40+
## Features
20241

203-
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
42+
- Simple, Easy-to-Extend codebase, [Blueprint Pattern](https://app-generator.dev/blog/flask-blueprints-a-developers-guide/)
43+
- Up-to-date Dependencies
44+
- [Pixel UI Kit](https://app-generator.dev/docs/templates/bootstrap/pixel-bootstrap.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
20453

205-
**Pixel PRO** is a premium design crafted by the `Themesberg` agency on top of Bootstrap 5 Framework. **Pixel** is a premium `Bootstrap 5 UI Kit` that provides 1000+ components, 50+ sections and 35 example pages including a fully fledged user dashboard.
206-
207-
- 👉 [Flask Pixel PRO](https://appseed.us/product/pixel-bootstrap-pro/flask/) - product page
208-
- 👉 [Flask Pixel PRO](https://flask-pixel-pro.appseed-srv1.com/) - LIVE Demo
209-
210-
![Pixel Bootstrap PRO - Full-Stack Starter generated by AppSeed](https://user-images.githubusercontent.com/51070104/168760719-f0e45406-2b2a-43e0-badf-fa953edb62b8.png)
54+
![Pixel Bootstrap Lite - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168753915-d61b2f97-57b2-4d14-a774-d217d120ff62.png)
21155

21256
<br />
21357

21458
---
215-
[Flask Pixel Lite](https://appseed.us/product/pixel-bootstrap/flask/) - Open-source Flask Starter provided by **[App Generator](https://app-generator.dev/)**.
59+
[Flask Pixel UI Kit](https://app-generator.dev/product/pixel-bootstrap/flask/) - Open-Source **Flask** Starter provided by [App Generator](https://app-generator.dev)

0 commit comments

Comments
 (0)