diff --git a/README.md b/README.md index bef287fec..670c06ce7 100755 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Run `make help` to see all tasks. ## Docker and Compose   [![docker hub](https://img.shields.io/docker/v/pokeapi/pokeapi?label=tag&sort=semver)](https://hub.docker.com/r/pokeapi/pokeapi) -There is also a multi-container setup, managed by [Docker Compose](https://docs.docker.com/compose/). This setup allows you to deploy a production-like environment, with separate containers for each service, and is recommended if you need to simply spin up PokéAPI. +There is also a multi-container setup, managed by [Docker Compose V2](https://docs.docker.com/compose/). This setup allows you to deploy a production-like environment, with separate containers for each service, and is recommended if you need to simply spin up PokéAPI. Start everything by @@ -83,9 +83,9 @@ make docker-setup If you don't have `make` on your machine you can use the following commands ```sh -docker-compose up -d -docker-compose exec -T app python manage.py migrate --settings=config.docker-compose -docker-compose exec -T app sh -c 'echo "from data.v2.build import build_all; build_all()" | python manage.py shell --settings=config.docker-compose' +docker compose up -d +docker compose exec -T app python manage.py migrate --settings=config.docker-compose +docker compose exec -T app sh -c 'echo "from data.v2.build import build_all; build_all()" | python manage.py shell --settings=config.docker-compose' ``` Browse [localhost/api/v2/](http://localhost/api/v2/) or [localhost/api/v2/pokemon/bulbasaur/](http://localhost/api/v2/pokemon/bulbasaur/) on port `80`. @@ -105,7 +105,7 @@ make docker-migrate ## GraphQL   -When you start PokéAPI with the above docker-compose setup, an [Hasura Engine](https://github.com/hasura/graphql-engine) server is started as well. It's possible to track all the PokeAPI tables and foreign keys by simply +When you start PokéAPI with the above Docker Compose setup, an [Hasura Engine](https://github.com/hasura/graphql-engine) server is started as well. It's possible to track all the PokeAPI tables and foreign keys by simply ```sh # hasura cli needs to be installed and available in your $PATH: https://hasura.io/docs/latest/graphql/core/hasura-cli/install-hasura-cli.html @@ -153,24 +153,24 @@ This k8s setup creates all k8s resources inside the _Namespace_ `pokeapi`, run ` | Python 2/3 | [PokeAPI/pokepy](https://github.com/PokeAPI/pokepy) | _Auto caching_ | | Python 3 | [PokeAPI/pokebase](https://github.com/PokeAPI/pokebase) | _Auto caching_, _Image caching_ | -|Wrapper |Repository |Features | -|----------------------------------|-------------------------------------------------------------------------------------------|---------------------------| -|.Net Standard |[mtrdp642/PokeApiNet](https://github.com/mtrdp642/PokeApiNet) |Auto caching | -|Dart |[prathanbomb/pokedart](https://github.com/prathanbomb/pokedart) | | -|Go |[mtslzr/pokeapi-go](https://github.com/mtslzr/pokeapi-go) |Auto caching | -|PHP |[lmerotta/phpokeapi](https://github.com/lmerotta/phpokeapi) |Auto caching, lazy loading | -|PowerShell |[Celerium/PokeAPI-PowerShellWrapper](https://github.com/Celerium/PokeAPI-PowerShellWrapper)| | -|Python |[beastmatser/aiopokeapi](https://github.com/beastmatser/aiopokeapi) |Auto caching, asynchronous | -|Ruby |[rdavid1099/poke-api-v2](https://github.com/rdavid1099/poke-api-v2) | | -|Rust |[lunik1/pokerust](https://gitlab.com/lunik1/pokerust) |Auto caching | -|Scala |[juliano/pokeapi-scala](https://github.com/juliano/pokeapi-scala) |Auto caching | -|Spring Boot |[dlfigueira/spring-pokeapi](https://github.com/dlfigueira/spring-pokeapi) |Auto caching | -|Swift |[kinkofer/PokemonAPI](https://github.com/kinkofer/PokemonAPI) | | -|Typescript server-side/client-side|[Gabb-c/Pokenode-ts](https://github.com/Gabb-c/pokenode-ts) |Auto caching | +|Wrapper|Repository|Features| +|---|---|---| +|.Net Standard |[mtrdp642/PokeApiNet](https://github.com/mtrdp642/PokeApiNet)|Auto caching | +|Dart|[prathanbomb/pokedart](https://github.com/prathanbomb/pokedart)| | +|Go|[mtslzr/pokeapi-go](https://github.com/mtslzr/pokeapi-go)|Auto caching | +|PHP |[lmerotta/phpokeapi](https://github.com/lmerotta/phpokeapi)|Auto caching, lazy loading | +|PowerShell|[Celerium/PokeAPI-PowerShellWrapper](https://github.com/Celerium/PokeAPI-PowerShellWrapper)| | +|Python|[beastmatser/aiopokeapi](https://github.com/beastmatser/aiopokeapi)|Auto caching, asynchronous | +|Ruby|[rdavid1099/poke-api-v2](https://github.com/rdavid1099/poke-api-v2)| | +|Rust|[lunik1/pokerust](https://gitlab.com/lunik1/pokerust)|Auto caching | +|Scala |[juliano/pokeapi-scala](https://github.com/juliano/pokeapi-scala)|Auto caching | +|Spring Boot |[dlfigueira/spring-pokeapi](https://github.com/dlfigueira/spring-pokeapi)|Auto caching | +|Swift |[kinkofer/PokemonAPI](https://github.com/kinkofer/PokemonAPI)| | +|Typescript server-side/client-side|[Gabb-c/Pokenode-ts](https://github.com/Gabb-c/pokenode-ts)|Auto caching | ## Donations -Help to keep PokéAPI running! If you're using PokéAPI as a teaching resource or for a project, consider sending us a $10 donation to help keep the service up. We get 330 million requests a month! +Help to keep PokéAPI running! If you're using PokéAPI as a teaching resource or for a project, consider sending us a donation to help keep the service up. We get 1+ billion requests a month! Thank you to all our backers! [Become a backer](https://opencollective.com/pokeapi#backer) diff --git a/Resources/docker/app/README.md b/Resources/docker/app/README.md index 8e2b87794..48c5d5486 100644 --- a/Resources/docker/app/README.md +++ b/Resources/docker/app/README.md @@ -35,7 +35,7 @@ The container connects to a Redis cache via the environment variable `REDIS_CONN ### 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](./how-to-use-this-image) for mapping the environment variables. +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](#how-to-use-this-image) for mapping the environment variables. It's recommended to use the provided [docker-compose.yml](https://github.com/PokeAPI/pokeapi/blob/master/docker-compose.yml) to start a container from this image.