|
1 | | -# [Gradient Able Flask](https://appseed.us/product/gradient-able/flask/) |
| 1 | +# [Flask Gradient Able](https://app-generator.dev/product/gradient-able/flask/) |
2 | 2 |
|
3 | | -Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** generated by `AppSeed` on top of a modern design. **Gradient Able** Bootstrap Lite is the most stylized Bootstrap 5 Admin Template, around all other Lite/Free admin templates in the market. It comes with highly feature-rich pages and components with fully developer-centric code. |
| 3 | +Open-source **Flask** project crafted on top of **Gradient Able Dashboard**, an open-source `Bootstrap` design. |
| 4 | +The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. |
4 | 5 |
|
5 | | -- 👉 [Gradient Able Flask](https://appseed.us/product/gradient-able/flask/) - Product page |
6 | | -- 👉 [Gradient Able Flask](https://flask-gradient-able.appseed-srv1.com/) - LIVE deployment |
7 | | - |
8 | | -<br /> |
9 | | - |
10 | | -## Features |
11 | | - |
12 | | -> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed** |
13 | | -
|
14 | | -| Free Version | [PRO Version](https://appseed.us/product/gradient-able-pro/flask/) | [Custom Development](https://appseed.us/custom-development/) | |
15 | | -| --------------------------------------| --------------------------------------| --------------------------------------| |
16 | | -| ✓ **Up-to-date dependencies** | **Everything in Free**, plus: | **Everything in PRO**, plus: | |
17 | | -| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1 Week** `Custom Development` | |
18 | | -| ✓ DB: SQLite, MySql | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/) | ✅ **Team**: PM, Developer, Tester | |
19 | | -| ✓ DB Tools: ORM, Flask-Migrate | ✅ `Private REPO Access` | ✅ Weekly Sprints | |
20 | | -| ✓ Session-Based authentication | - | ✅ Technical SPECS | |
21 | | -| ✓ `Docker` | - | ✅ Documentation | |
22 | | -| ✓ `CI/CD` Flow via Render | - | ✅ **30 days Delivery Warranty** | |
23 | | -| ✓ `Free Support` | - | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** | |
24 | | -| --------------------------------- | --------------------------------- | --------------------------------- | |
25 | | -| ✓ [LIVE Demo](https://flask-gradient-able.appseed-srv1.com/) | 🚀 [LIVE Demo](https://flask-gradient-pro.appseed-srv1.com/) `PRO` | **[Get in Touch ➡️](https://appseed.us/custom-development/)** | |
26 | | - |
27 | | - |
28 | | - |
29 | | -<br /> |
30 | | - |
31 | | -## ✅ Start in `Docker` |
32 | | - |
33 | | -> 👉 **Step 1** - Download the code from the GH repository (using `GIT`) |
34 | | -
|
35 | | -```bash |
36 | | -$ git clone https://github.com/app-generator/flask-gradient-able.git |
37 | | -$ cd flask-gradient-able |
38 | | -``` |
| 6 | +- 👉 [Flask Gradient Able](https://app-generator.dev/product/gradient-able/flask/) - `Product Page` |
| 7 | +- 👉 [Flask Gradient Able](flask-gradient-able.appseed-srv1.com) - `LIVE Demo` |
| 8 | +- 👉 [Flask Gradient Able Documentation](https://app-generator.dev/docs/products/flask/gradient-able/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` |
39 | 15 |
|
40 | 16 | <br /> |
41 | 17 |
|
42 | | -> 👉 **Step 2** - Start the APP in `Docker` |
43 | | -
|
44 | | -```bash |
45 | | -$ docker-compose up --build |
46 | | -``` |
47 | | - |
48 | | -Visit `http://localhost:5085` in your browser. The app should be up & running. |
49 | | - |
50 | | -<br /> |
51 | | - |
52 | | -## ✅ Manual Build |
53 | | - |
54 | | -> Download the code |
55 | | -
|
56 | | -```bash |
57 | | -$ git clone https://github.com/app-generator/flask-gradient-able.git |
58 | | -$ cd flask-gradient-able |
59 | | -``` |
60 | | - |
61 | | -<br /> |
62 | | - |
63 | | -### 👉 Set Up for `Unix`, `MacOS` |
64 | | - |
65 | | -> Install modules via `VENV` |
66 | | -
|
67 | | -```bash |
68 | | -$ virtualenv env |
69 | | -$ source env/bin/activate |
70 | | -$ pip3 install -r requirements.txt |
71 | | -``` |
72 | | - |
73 | | -<br /> |
74 | | - |
75 | | -> Set Up Flask Environment |
76 | | -
|
77 | | -```bash |
78 | | -$ export FLASK_APP=run.py |
79 | | -$ export FLASK_ENV=development |
80 | | -``` |
81 | | - |
82 | | -<br /> |
83 | | - |
84 | | -> Start the app |
| 18 | +## Features |
85 | 19 |
|
86 | | -```bash |
87 | | -$ flask run |
88 | | -``` |
| 20 | +- Simple, Easy-to-Extend codebase, [Blueprint Pattern](https://app-generator.dev/blog/flask-blueprints-a-developers-guide/) |
| 21 | +- [Gradient Able](https://app-generator.dev/docs/templates/bootstrap/gradient-able.html) Full Integration |
| 22 | +- [Bootstrap](https://app-generator.dev/docs/templates/bootstrap/index.html) 5 Styling |
| 23 | +- Auth: Session Based, GitHub, Google |
| 24 | +- Celery Beat |
| 25 | +- DB Persistence: SQLite (default), |
| 26 | + - Easy switch to MySql/MariaDB, PgSql |
| 27 | +- [Dynamic DataTables](https://flask-gradient-demo.onrender.com/dynamic-dt) - manage data without coding |
| 28 | +- CI/CD integration for [Render](https://app-generator.dev/docs/deployment/render/index.html) |
| 29 | +- Deployment: Docker, Flask-Minify |
89 | 30 |
|
90 | | -At this point, the app runs at `http://127.0.0.1:5000/`. |
| 31 | + |
91 | 32 |
|
92 | 33 | <br /> |
93 | 34 |
|
94 | | -### 👉 Set Up for `Windows` |
95 | | - |
96 | | -> Install modules via `VENV` (windows) |
97 | | -
|
98 | | -``` |
99 | | -$ virtualenv env |
100 | | -$ .\env\Scripts\activate |
101 | | -$ pip3 install -r requirements.txt |
102 | | -``` |
| 35 | +## Deploy LIVE |
103 | 36 |
|
104 | | -<br /> |
105 | | - |
106 | | -> Set Up Flask Environment |
| 37 | +> One-click deploy (requires already having an account). |
107 | 38 |
|
108 | | -```bash |
109 | | -$ # CMD |
110 | | -$ set FLASK_APP=run.py |
111 | | -$ set FLASK_ENV=development |
112 | | -$ |
113 | | -$ # Powershell |
114 | | -$ $env:FLASK_APP = ".\run.py" |
115 | | -$ $env:FLASK_ENV = "development" |
116 | | -``` |
| 39 | +[](https://render.com/deploy) |
117 | 40 |
|
118 | 41 | <br /> |
119 | 42 |
|
120 | | -> Start the app |
| 43 | +## [Gradient Able PRO Version](https://app-generator.dev/product/gradient-able-pro/flask/) |
121 | 44 |
|
122 | | -```bash |
123 | | -$ flask run |
124 | | -``` |
| 45 | +> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://flask-gradient-pro.onrender.com/). |
125 | 46 |
|
126 | | -At this point, the app runs at `http://127.0.0.1:5000/`. |
127 | | - |
128 | | -<br /> |
| 47 | +- **Simple, Easy-to-Extend** Codebase |
| 48 | +- **Gradient Able PRO** Design - Premium Version |
| 49 | +- **Docker** |
| 50 | +- **Deployment-Ready** for Render |
129 | 51 |
|
130 | | -## ✅ Codebase |
131 | | - |
132 | | -The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow: |
133 | | - |
134 | | -```bash |
135 | | -< PROJECT ROOT > |
136 | | - | |
137 | | - |-- apps/ |
138 | | - | | |
139 | | - | |-- home/ # A simple app that serve HTML files |
140 | | - | | |-- routes.py # Define app routes |
141 | | - | | |
142 | | - | |-- authentication/ # Handles auth routes (login and register) |
143 | | - | | |-- routes.py # Define authentication routes |
144 | | - | | |-- models.py # Defines models |
145 | | - | | |-- forms.py # Define auth forms (login and register) |
146 | | - | | |
147 | | - | |-- static/ |
148 | | - | | |-- <css, JS, images> # CSS files, Javascripts files |
149 | | - | | |
150 | | - | |-- templates/ # Templates used to render pages |
151 | | - | | |-- includes/ # HTML chunks and components |
152 | | - | | | |-- navigation.html # Top menu component |
153 | | - | | | |-- sidebar.html # Sidebar component |
154 | | - | | | |-- footer.html # App Footer |
155 | | - | | | |-- scripts.html # Scripts common to all pages |
156 | | - | | | |
157 | | - | | |-- layouts/ # Master pages |
158 | | - | | | |-- base-fullscreen.html # Used by Authentication pages |
159 | | - | | | |-- base.html # Used by common pages |
160 | | - | | | |
161 | | - | | |-- accounts/ # Authentication pages |
162 | | - | | | |-- login.html # Login page |
163 | | - | | | |-- register.html # Register page |
164 | | - | | | |
165 | | - | | |-- home/ # UI Kit Pages |
166 | | - | | |-- index.html # Index page |
167 | | - | | |-- 404-page.html # 404 page |
168 | | - | | |-- *.html # All other pages |
169 | | - | | |
170 | | - | config.py # Set up the app |
171 | | - | __init__.py # Initialize the app |
172 | | - | |
173 | | - |-- requirements.txt # App Dependencies |
174 | | - | |
175 | | - |-- .env # Inject Configuration via Environment |
176 | | - |-- run.py # Start the app - WSGI gateway |
177 | | - | |
178 | | - |-- ************************************************************************ |
179 | | -``` |
| 52 | + |
180 | 53 |
|
181 | 54 | <br /> |
182 | 55 |
|
183 | | -## [PRO Version](https://appseed.us/product/gradient-able-pro/flask/) |
| 56 | +## `Customize` with [Flask Generator](https://app-generator.dev/tools/flask-generator/) |
184 | 57 |
|
185 | | -> For more components, pages and priority on support, feel free to take a look at this amazing starter: |
| 58 | +- Access the [Flask Generator](https://app-generator.dev/tools/flask-generator/) |
| 59 | +- Select the preferred design |
| 60 | +- (Optional) Design Database: edit models and fields |
| 61 | +- (Optional) Edit the fields for the extended user model |
| 62 | +- (Optional) Enable OAuth for GitHub |
| 63 | +- (Optional) Add Celery (async tasks) |
| 64 | +- (Optional) Enable Dynamic Tables Module |
| 65 | +- Docker Scripts |
| 66 | +- Render CI/Cd Scripts |
186 | 67 |
|
187 | | -Designed for those who like bold elements and beautiful websites, **Gradient Able** is the most stylish Bootstrap 5 Admin Template compare to all other Bootstrap admin templates. |
188 | | -It comes with high feature-rich pages and components with fully developer-centric code. |
| 68 | +**The generated Flask project is available as a ZIP Archive and also uploaded to GitHub.** |
189 | 69 |
|
190 | | -- 👉 [Flask Gradient PRO](https://appseed.us/product/gradient-able-pro/flask/) - product page |
191 | | -- 👉 [Flask Gradient PRO](https://flask-gradient-able-pro.appseed-srv1.com) - LIVE Deployment |
| 70 | + |
192 | 71 |
|
193 | | - |
| 72 | + |
194 | 73 |
|
195 | 74 | <br /> |
196 | 75 |
|
197 | 76 | --- |
198 | | -[Gradient Able Flask](https://appseed.us/product/gradient-able/flask/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**. |
| 77 | +[Flask Gradient Able](https://app-generator.dev/product/gradient-able/flask/) - Open-Source **Flask** Starter provided by [App Generator](https://app-generator.dev) |
0 commit comments