https://github.com/italomaia/flask-empty-api
AZAP Flask boilerplate for creating API's with flask.
https://github.com/italomaia/flask-empty-api
boilerplate flask python rest webframework websocket
Last synced: about 1 year ago
JSON representation
AZAP Flask boilerplate for creating API's with flask.
- Host: GitHub
- URL: https://github.com/italomaia/flask-empty-api
- Owner: italomaia
- Created: 2018-02-05T00:50:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-05T01:51:37.000Z (over 8 years ago)
- Last Synced: 2025-03-18T19:38:27.541Z (over 1 year ago)
- Topics: boilerplate, flask, python, rest, webframework, websocket
- Language: Python
- Size: 13.7 KB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flask Empty API
Docker Powered Flask boilerplate for super fast prototyping.
Get you Flask Rest Token Authenticated Websocket-ready project
running with a single command.
## Getting Started
* Make sure docker, docker-compose and fabric are installed
* Clone the repo with any name you like
* Go to the project folder and run: `fab env:dev up` (project is now running)
* In another terminal, create the database with: `fab env:dev on:app run:"flask db upgrade"`
## Available Endpoints (out-of-the-box)
* /login
* /logout
* / # index
## Useful
* `fab env:dev on:app run:"flask shell"` # bring up flask shell
* `fab env:dev on:app run:"flask db migrate --rev-id 001 -m message"` # create revision
* `fab env:dev attach:containerID` # attach to tty; logs and pdb
## Deployment
* configure your swarm secrets
* tune flask configuration for security (SSL, MAILING, etc)
* make sure envfile variables are production ready
* open the champaign