RESTful API that serves the most famous quotes from all time. Built with Flask-RESTful.
- RESTful API created with Flask-RESTful
- MongoDB integration with Flask-Mongoengine
- Open API specification documentation
| Environment | Endpoint |
|---|---|
| LOCAL | Swagger Docs |
| PROD | Swagger Docs |
Follow the instructions below to work on the project on your local environment.
In case you don't use Docker, you'll need Git, Python 3.8, Pip and a Virtual Environment (in this case, Pipenv is used as a package manager and virtual environment).
# Clone this repository
$ git clone https://github.com/miguel-osuna/Quotes-API.git
# Go into the repository from the terminal
$ cd Quotes-API
# Remove current origin repository
$ git remote remove origin
All dependencies are listed on the Pipfile.
This will run the project on your local environment.
Make sure to create a hidden folder like envs.example named .envs, with the same kind of environment variables.
docker-compose -f local.yml build
docker-compose -f local.yml up -d
docker-compose -f local.yml up -d --build
The project supports cli commands for formatting, linting, database initialization and more.
| Action | Command |
|---|---|
| Test | pipenv run test |
| Format | pipenv run format |
| Lint | pipenv run lint |
This project includes configuration files for both Heroku and AWS using Zappa.
- Heroku: read the following tutorial to learn how to deploy to your heroku account..
- Zappa: read the following tutorial to learn how to deploy to your aws account using zappa.
See the project documentation
- Miguel Osuna - https://github.com/miguel-osuna
This project is licensed under the MIT License - see the LICENSE.md file for details.