https://github.com/cuongnb14/cookiecutter-flask-restful
Cookiecutter Flask-RESTful is a framework for jumpstarting production-ready Flask-RESTful projects quickly.
https://github.com/cuongnb14/cookiecutter-flask-restful
Last synced: 7 months ago
JSON representation
Cookiecutter Flask-RESTful is a framework for jumpstarting production-ready Flask-RESTful projects quickly.
- Host: GitHub
- URL: https://github.com/cuongnb14/cookiecutter-flask-restful
- Owner: cuongnb14
- License: mit
- Created: 2017-10-24T10:52:42.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-22T15:02:18.000Z (over 7 years ago)
- Last Synced: 2025-01-13T10:51:56.214Z (9 months ago)
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cookiecutter Flask-RESTful
Powered by [Cookiecutter](https://github.com/audreyr/cookiecutter). Cookiecutter Flask-RESTful is a framework for jumpstarting production-ready Flask-RESTful projects quickly.
## Introduction
This cookie cutter is a very simple boilerplate for starting a REST api using Flask, Flask-RESTful, Celery. It comes with basic project structure and configuration, celery task.
**Features:**
- For Flask 0.12.2 and Flask RESTful 0.3.6
- Simple flask-RESTful application
- Flask command line interface integration
- Implementation simple cli: init database, list all router
- Implementation simple middleware
- Implementation simple Flask-JWT-Extended
- Implementation simple Flask Admin
- Configured logging (integrate notify to slack)
- Integrate celery for handle long process
- Simple pagination utils
- Configuration using environment variable
- Dockerizer
- Use Makefile to install
**Used packages:**
- [Flask](http://flask.pocoo.org/)
- [Flask-RESTful](https://flask-restful.readthedocs.io/en/latest/)
- [Flask-JWT-Extended](http://flask-jwt-extended.readthedocs.io/en/latest/index.html)
- [Flask-Admin](https://flask-admin.readthedocs.io/en/latest/)
- [mysqlclient](https://github.com/PyMySQL/mysqlclient-python)
- [Flask-SQLAlchemy](http://flask-sqlalchemy.pocoo.org/2.3/)
- [Celery](http://www.celeryproject.org/)
- [gunicorn](http://gunicorn.org/)
## Usage
Step 1: Init project
`cookiecutter https://github.com/cuongnb14/cookiecutter-flask-restful.git`
Step 2: Install requirements
`make install-requirements`
Step 3: Build docker images
`make build`
Step 4: Run mysql container
`docker-compose up -d mysql`
Step 5: Init database schema
`make init-db`
Step 6: Run project
- Without docker: `make run`
- With docker: `make up`