Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/rocket-flask-v3
Flask v3 - Open-Source Sample | AppSeed
https://github.com/app-generator/rocket-flask-v3
flask flask-v3 flask-v3-cicd flask-v3-sample flask-v3-template flask3 flask3-free-sample flask3-sample
Last synced: 17 days ago
JSON representation
Flask v3 - Open-Source Sample | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/rocket-flask-v3
- Owner: app-generator
- Created: 2023-10-01T18:59:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-01T20:21:24.000Z (over 1 year ago)
- Last Synced: 2024-12-15T21:18:58.721Z (22 days ago)
- Topics: flask, flask-v3, flask-v3-cicd, flask-v3-sample, flask-v3-template, flask3, flask3-free-sample, flask3-sample
- Language: SCSS
- Homepage: https://flask-v3-sample.onrender.com
- Size: 25 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Flask v3 Sample](https://flask-v3-sample.onrender.com/)
Open-source **Flask/Jinja Template** provided by `AppSeed` on top of **[Soft UI Dashboard](https://appseed.us/product/soft-ui-dashboard/flask/)**, a modern `Bootstrap 5` dashboard design.
> 👉 **[Flask v3 Sample](https://flask-v3-sample.onrender.com/)** - `LIVE Demo`
The project is a super simple Flask project WITHOUT database, ORM, or any other hard dependency - Design from **[Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200)**.
## Features
- ✅ `Up-to-date dependencies` using a **Flask v3.0.0** compatible stack
- ✅ Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
- ✅ **UI Kit**: [Soft Dashboard BS5](https://www.creative-tim.com/product/soft-ui-dashboard?AFFILIATE=128200) by Creative-Tim
- ✅ `Docker`
- ✅ `CI/CD` via Render
## Start with `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/rocket-flask-v3.git
$ cd rocket-flask-v3
```
> 👉 **Step 2** - Start the APP in `Docker`
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## Manual Build
> Download the code
```bash
$ git clone https://github.com/app-generator/rocket-flask-v3.git
$ cd rocket-flask-v3
```
### 👉 Set Up for `Unix`, `MacOS`
> Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
```
> Start the app
```bash
$ flask run
```
At this point, the app runs at `http://127.0.0.1:5000/`.
### 👉 Set Up for `Windows`
> Install modules via `VENV` (windows)
```
$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ # CMD
$ set FLASK_APP=run.py
$ set FLASK_ENV=development
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_ENV = "development"
```
> Start the app
```bash
$ flask run
```
At this point, the app runs at `http://127.0.0.1:5000/`.
## **Deploy on Render**
- Create a Blueprint instance
- Go to https://dashboard.render.com/blueprints this link.
- Click `New Blueprint Instance` button.
- Connect your `repo` which you want to deploy.
- Fill the `Service Group Name` and click on the `Update Existing Resources` button.
- Edit the Environment and [specify the PYTHON_VERSION](https://render.com/docs/python-version)
- Version `3.11.5` was used for **[this deployment](https://flask-v3-sample.onrender.com/)**
- After that, your deployment will start automatically.
At this point, the product should be LIVE.
## Codebase Structure
The project has a simple, intuitive structure presented bellow:
```bash
< PROJECT ROOT >
|
|-- apps/__init__.py
|-- apps/
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/
| |
| |-- includes/ # Page chunks, components
| | |
| | |-- navigation.html # Top bar
| | |-- sidebar.html # Left sidebar
| | |-- scripts.html # JS scripts common to all pages
| | |-- footer.html # The common footer
| |
| |-- layouts/ # App Layouts (the master pages)
| | |
| | |-- base.html # Used by common pages like index, UI
| | |-- base-fullscreen.html # Used by auth pages (login, register)
| |
| index.html # The default page
| page-404.html # Error 404 page (page not found)
| page-500.html # Error 500 page (server error)
| *.html # All other pages provided by the UI Kit
|
|-- requirements.txt
|
|-- run.py
|
|-- ************************************************************************
```
## [Flask Soft Dashboard](https://appseed.us/product/soft-ui-dashboard-pro/flask/) `PRO`
> For more components, pages and priority on support, feel free to take a look at this starter:
Soft UI Dashboard is a premium [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Design now available for download in Flask. Made of hundred of elements, designed blocks, and fully coded pages, Soft UI Dashboard PRO is ready to help you create stunning websites and web apps.
- 👉 [Soft UI Dashboard PRO Flask](https://appseed.us/product/soft-ui-dashboard-pro/flask/) - `product page`
- ✅ `Enhanced UI` - more pages and components
- ✅ `Priority` on support
---
[Soft Dashboard](https://appseed.us/product/soft-ui-dashboard/flask/) Flask/Jinja - Open-source starter crafted by **[AppSeed](https://appseed.us/)**.