https://github.com/mrteale/flask-restful-api-boilerplate
RESTFUL API built with Flask and ability to connect to Firebase
https://github.com/mrteale/flask-restful-api-boilerplate
api boilerplate boilerplate-template firebase firebase-database flask flask-api python python-3-6
Last synced: about 2 months ago
JSON representation
RESTFUL API built with Flask and ability to connect to Firebase
- Host: GitHub
- URL: https://github.com/mrteale/flask-restful-api-boilerplate
- Owner: MrTeale
- Created: 2017-02-27T16:14:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-04T05:43:41.000Z (about 9 years ago)
- Last Synced: 2025-01-26T18:28:00.495Z (over 1 year ago)
- Topics: api, boilerplate, boilerplate-template, firebase, firebase-database, flask, flask-api, python, python-3-6
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Python Flask Restful API Boilerplate with Database Integration
This boilerplate is a simple framework created to cut down the time when developing an API for python.
It uses Flask for web routing and Pyrebase to interact with Google's mobile and web application tool Firebase.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
In order to run this project you will need two frameworks: Flask and Pyrebase.
```
pip install flask
pip install pyrebase
```
### Installing
Download and move the files to the location of your choosing (maintaining the file structure). Having previously installed all the prerequisites, the application should be able to work right out of the box. If errors occur, please check you're using python 3.6 and all modules are up to date.
## Built With
* [Python 3.6](https://www.python.org/) - The language used
* [Flask](http://flask.pocoo.org/) - Framework to route web requests
* [Pyrebase](https://github.com/thisbejim/Pyrebase) - Framework to interact with Firebase
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details