https://github.com/damianoalves/flask-service
:globe_with_meridians: A Backend service template project developed with Python Flask
https://github.com/damianoalves/flask-service
flask-application flask-restful flask-sqlalchemy heroku jwt-authentication python python-3 rest-api
Last synced: about 1 month ago
JSON representation
:globe_with_meridians: A Backend service template project developed with Python Flask
- Host: GitHub
- URL: https://github.com/damianoalves/flask-service
- Owner: damianoalves
- License: mit
- Created: 2018-05-02T15:25:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T23:49:08.000Z (6 months ago)
- Last Synced: 2025-03-30T08:09:56.069Z (about 1 month ago)
- Topics: flask-application, flask-restful, flask-sqlalchemy, heroku, jwt-authentication, python, python-3, rest-api
- Language: Python
- Homepage:
- Size: 57.6 KB
- Stars: 83
- Watchers: 2
- Forks: 25
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flask API
This is a Flask API that I will keep improving with new features and functionalities.
This boilerplate can be used as a template for bigger projects.
## đź”´ I'll start to improve this project again after a couple of years
### Introduction
The “micro” in microframework means Flask aims to keep the core simple but extensible. Flask won’t make many decisions for you, such as what database to use.
By convention, templates and static files are stored in subdirectories within the application’s Python source tree, with the names templates and static respectively.
### Dependencies
* [Python](https://www.python.org/) - Programming Language
* [Flask](https://flask.palletsprojects.com/) - The framework used
* [SQLAlchemy](https://docs.sqlalchemy.org/) - ORM
* [Pydantic](https://pydantic-docs.helpmanual.io/) - Data validation
* [Alembic](https://alembic.sqlalchemy.org/) - Database Migrations
* [Pip](https://pypi.org/project/pip/) - Dependency Management
* [RESTful](https://restfulapi.net/) - REST docs
* [Representational State Transfer](https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm) - Article by Roy Fielding
### Virtual environments
```
$ sudo apt-get install python-virtualenv
$ python3 -m venv venv
$ . venv/bin/activate
$ pip install Flask
```
Install all project dependencies using:
```
$ pip install -r requirements.txt
```
### Running
```
$ export FLASK_APP=app.py
$ export FLASK_ENV=development
$ python -m flask run
```
This launches a very simple builtin server, which is good enough for testing but probably not what you want to use in production.
If you enable debug support the server will reload itself on code changes, and it will also provide you with a helpful debugger if things go wrong.
If you have the debugger disabled or trust the users on your network, you can make the server publicly available simply by adding --host=0.0.0.0 to the command line:
```
flask run --host=0.0.0.0
```
### Running using Manager
This app can be started using Flask Manager. It provides some useful commands and configurations, also, it can be customized with more functionalities.
```
python manage.py runserver
```
### Alembic Migrations
Use the following commands to create a new migration file and update the database with the last migrations version:
```
flask db revision --autogenerate -m "description here"
flask db upgrade head
```
This project also uses the customized manager command to perform migrations.
```
python manage.py db revision --autogenerate -m "description here"
python manage.py db upgrade head
```
To upgrade the database with the newest migrations version, use:
```
python manage.py db upgrade head
```
For more information, access [Auto generating migrations](https://alembic.sqlalchemy.org/en/latest/autogenerate.html).
## Contributing
This API was developed based on:
[Flask documentation](https://flask.palletsprojects.com/)
[REST APIs with Flask and Python](https://www.udemy.com/rest-api-flask-and-python/)
[The Ultimate Flask Course](https://www.udemy.com/the-ultimate-flask-course)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Certificate
[Certificate](https://www.udemy.com/certificate/UC-CYMYZILZ/)