Pokemon API that consumes the https://pokeapi.co/api/v2 API.
API/Swagger docs link: https://api-pokemon.urbanswati.co.za/docs
Frontend using the API link: https://pokemon.urbanswati.co.za/
Frontend source code, link
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Install the project dependencies either using pip or pipenv
pip install -r requirements
or with Pipenv
pipenv install -r
Then activate your environment on Pipenv
pipenv shell
Build the image
docker build . -t pokemonapi
Then run the container
docker run -p 80:80 -t pokemonapi
Then go to http://localhost or access the Swagger docs at http://localhost/docs
If you get an error concerning port 80 already being allocated change to a different port
example using port 8000
docker run -p 8000:80 -t pokemonapi
Then go to http://localhost:8000 or access the Swagger docs at http://localhost:8000/docs
To run tests use pytest
pytest
To run with coverage
pytest --cov
For code linting use black
black .
You can use heroku linked with your github account or AWS services (ECR, ECS, EKS, Elastic Beanstalk etc)
- FastAPI - The web framework used
- Pipenv - Dependency Management
- Docker - Used to containerize application
- Coffee - Used to give energy to spit out code
- William Maphanga - Initial work - UrbanSwati
See also the list of contributors who participated in this project.
This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details
- https://pokeapi.co/api/v2
- Coffee, again
- Python Team (whoop whoop!)
- FastAPI
- and last but not least, Stack Overflow