https://github.com/app-generator/boilerplate-code-flask
Boilerplate Code - Flask Template project | AppSeed
https://github.com/app-generator/boilerplate-code-flask
flask-apps flask-boilerplate flask-starter flask-template
Last synced: about 1 year ago
JSON representation
Boilerplate Code - Flask Template project | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/boilerplate-code-flask
- Owner: app-generator
- License: other
- Created: 2023-07-01T06:11:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-01T06:26:34.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T18:12:46.477Z (about 1 year ago)
- Topics: flask-apps, flask-boilerplate, flask-starter, flask-template
- Language: SCSS
- Homepage: https://appseed.us/apps/flask/
- Size: 6.24 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask Boilerplate](https://appseed.us/boilerplate-code/flask-boilerplate/)
Reference codebase used by `AppSeed` in all Flask [Apps](https://appseed.us/apps/flask/) and [Dashboard](https://appseed.us/admin-dashboards/flask/) starters - the product uses an amazing design crafted by `Creative-Tim`.
- 👉 [Flask Boilerplate](https://appseed.us/boilerplate-code/flask-boilerplate/) - `Product page`
- 👉 [Flask Boilerplate](https://flask-material-kit.appseed-srv1.com/) - `LIVE App`
- 👉 Free [Support](https://appseed.us/support/) via `Email` & `Discord`
> 🚀 Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-06-08 12:24`
- ✅ `Up-to-date dependencies`
- ✅ `Database`: `SQLite`, MySql
- Silent fallback to `SQLite`
- ✅ `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
- ✅ Session-Based authentication (via **flask_login**), Forms validation
- ✅ Docker, `Flask-Minify` (page compression)
- 🚀 `Deployment`
- `CI/CD` flow via `Render`
- [Flask Material Kit - Go LIVE](https://www.youtube.com/watch?v=bSFw6xrd57w) (`video presentation`)
## Start with `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/boilerplate-code-flask.git
$ cd boilerplate-code-flask
```
> 👉 **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/boilerplate-code-flask.git
$ cd boilerplate-code-flask
```
### 👉 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/`.
### 👉 Create Users
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
- Start the app via `flask run`
- Access the `registration` page and create a new user:
- `http://127.0.0.1:5000/register`
- Access the `sign in` page and authenticate
- `http://127.0.0.1:5000/login`
## Codebase Structure
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
```bash
< PROJECT ROOT >
|
|-- apps/
| |
| |-- home/ # A simple app that serve HTML files
| | |-- routes.py # Define app routes
| |
| |-- authentication/ # Handles auth routes (login and register)
| | |-- routes.py # Define authentication routes
| | |-- models.py # Defines models
| | |-- forms.py # Define auth forms (login and register)
| |
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/ # Templates used to render pages
| | |-- includes/ # HTML chunks and components
| | | |-- navigation.html # Top menu component
| | | |-- sidebar.html # Sidebar component
| | | |-- footer.html # App Footer
| | | |-- scripts.html # Scripts common to all pages
| | |
| | |-- layouts/ # Master pages
| | | |-- base-fullscreen.html # Used by Authentication pages
| | | |-- base.html # Used by common pages
| | |
| | |-- accounts/ # Authentication pages
| | | |-- login.html # Login page
| | | |-- register.html # Register page
| | |
| | |-- home/ # UI Kit Pages
| | |-- index.html # Index page
| | |-- 404-page.html # 404 page
| | |-- *.html # All other pages
| |
| config.py # Set up the app
| __init__.py # Initialize the app
|
|-- requirements.txt # App Dependencies
|
|-- .env # Inject Configuration via Environment
|-- run.py # Start the app - WSGI gateway
|
|-- ************************************************************************
```
---
[Flask Boilerplate](https://appseed.us/boilerplate-code/flask-boilerplate/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.