Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Raniita/cookiecutter-flask-yatf
cookiecutter Flask Template/Boilerplate with Flask-Login, Flask-SQLAlchemy, CI/CD...
https://github.com/Raniita/cookiecutter-flask-yatf
cookiecutter cookiecutter-template flask flask-application python-flask sqlalchemy-python
Last synced: about 1 month ago
JSON representation
cookiecutter Flask Template/Boilerplate with Flask-Login, Flask-SQLAlchemy, CI/CD...
- Host: GitHub
- URL: https://github.com/Raniita/cookiecutter-flask-yatf
- Owner: Raniita
- Created: 2020-11-23T10:33:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-31T10:18:21.000Z (almost 3 years ago)
- Last Synced: 2024-02-16T00:51:38.985Z (5 months ago)
- Topics: cookiecutter, cookiecutter-template, flask, flask-application, python-flask, sqlalchemy-python
- Language: Python
- Homepage:
- Size: 70.3 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Lists
- jimsghstars - Raniita/cookiecutter-flask-yatf - cookiecutter Flask Template/Boilerplate with Flask-Login, Flask-SQLAlchemy, CI/CD... (Python)
README
# YAFT (yes-another-flask-template)
Flask template starter powered with [Cookiecutter](https://github.com/cookiecutter/cookiecutter).
## Description
Light starter of fully opinionated Flask template. Based on previous experience. Be free to open an issue or fork this repo.
## Usage
Install cookiecutter
```bash
$ pip install cookiecutter
```
on Arch Linux, use:
```bash
$ sudo pacman -S python-cookiecutter
```
Generate the project using the template
```bash
$ cookiecutter https://github.com/Raniita/yes-another-flask-template.git
```
Fill the differents vars for the project.
### Optional
* Configure virtual environment (pipenv, venv, ...)
* Install python package requeriments:
```bash
$ pip install -r requeriments.txt
```
* Setup git
* Add License.md
## Features
Powered with this extensions:
- Flask >= 2.0
- Flask CLI commands
- Flask-Minify
- Flask-SQLAlchemy
- Flask-Migrate
- Flask-bcrypt
- Flask-Login
- Flask-Admin
- Flask-WTF
- Flask-RQ2
- Flask-DebugToolBar
Extras:
- Blueprints and [application factory pattern](https://flask.palletsprojects.com/en/2.0.x/patterns/appfactories/)
- Continous integration with [drone.ci](https://www.drone.io/)
- Access control to views based on roles
- Admin panel (File browser, DB management)
- Admin dashboard
- Gotify push notifications
- Deploy based en Docker [docker-compose]
## License
[AGPL-3.0](https://choosealicense.com/licenses/agpl/)