mirror of https://github.com/PokeAPI/pokeapi synced 2024-09-20 06:01:54 +00:00

History

Alessandro Pezzè 79a8d2bfaf Merge branch 'master' into compose-v2		2024-05-08 21:14:35 +02:00
..
Dockerfile	fix: merge in one command and delete .build-deps	2024-05-04 22:09:03 +02:00
README.md	docs: use Compose V2/markdown tables/clarifications	2024-03-25 22:01:52 +01:00

README.md

Quick reference

Maintained by: the PokeAPI Contributors
Where to get help: PokeAPI Slack.
Where to file issues: https://github.com/PokeAPI/pokeapi/issues
Source of this description: pokeapi repo's Resources/docker/app/ directory

Supported tags and respective `Dockerfile` links

pokeapi uses python:3.10-alpine as base image.

What is PokeAPI?

PokeAPI is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series.

pokeapi.co

How to use this image

This container connects to a Postgres database via the environment variables POSTGRES_DB, POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_HOST, POSTGRES_PORT.

The container connects to a Redis cache via the environment variable REDIS_CONNECTION_STRING.

Run the container

The container exposes port 80. It needs a PostgreSQL and a Redis instance to connect to. Refer to the section How to use this image for mapping the environment variables.

It's recommended to use the provided docker-compose.yml to start a container from this image.

Build the data

Pokémon data isn't automatically present in this image. All Pokémon data is persisted in a PostgreSQL database and thus needs to be built.

When the container is up and running, run the following shell commands:

docker exec pokeapi python manage.py migrate --settings=config.docker-compose
docker exec pokeapi sh -c 'echo "from data.v2.build import build_all; build_all()" | python manage.py shell --settings=config.docker-compose'