Pokedex.Api

Pokedex.Api is a REST Api that was built to serve data for Pokedex to reduce the amount of calls to PokeApi. This app has only one endpoint which shares the list of pokemons with basic info to easily display cards of each pokemon. The data is periodically updated once a day with data fetched from PokeApi. It is deployed on heroku.

Table of contents

• Technologies
• Installation
• Usage
• Status
• License

Technologies

• Python 3.9.5
• Django REST framework 3.12.4
• Django celery beat 2.2.0
• Celery 5.0.5
• PostgreSQL latest (13.3)
• Redis latest (6.2.3)
• Gunicorn 20.1.0

Here you can check all dependencies.

Installation

Prerequisites

Docker is required to run the app locally.

Setup

1. Create .env file in the root directory with the config of environment variables. Here you can check the example of the configuration.
2. Build and run the docker container.

docker-compose up

App is now available at http://127.0.0.1:8000/.

Usage

1. Root endpoint: http://127.0.0.1:8000/
   
   

2. Pokemons endpoint: http://127.0.0.1:8000/pokemons
   
   

Status

Currently, the app is considered as finished and there are no plans to do any updates on it.

License

MIT