You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Download this source code into a working directory, be sure to use the flag `--recurse-submodules` to clone also our submodules.
26
42
@@ -43,7 +59,7 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
43
59
make serve
44
60
```
45
61
46
-
### Database setup
62
+
## Database setup <a id="database-setup"></a>
47
63
48
64
To build or rebuild the database by applying any CSV file update, run
49
65
@@ -70,7 +86,7 @@ make migrate
70
86
71
87
Run `make help` to see all tasks.
72
88
73
-
## Docker and Compose [](https://hub.docker.com/r/pokeapi/pokeapi)
89
+
## Docker and Compose <a id="docker-and-compose"></a> [](https://hub.docker.com/r/pokeapi/pokeapi)
74
90
75
91
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.
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
109
125
@@ -119,7 +135,7 @@ A free public GraphiQL console is browsable at the address https://beta.pokeapi.
119
135
120
136
A set of examples is provided in the directory [/graphql/examples](./graphql/examples) of this repository.
121
137
122
-
## Kubernetes [](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml)
138
+
## Kubernetes <a id="kubernetes"></a> [](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml)
123
139
124
140
[Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/) files are provided in the folder https://github.com/PokeAPI/pokeapi/tree/master/Resources/k8s/kustomize/base/. Create and change your secrets:
This k8s setup creates all k8s resources inside the _Namespace_ `pokeapi`, run `kubectl delete namespace pokeapi` to delete them. It also creates a _Service_ of type`LoadBalancer` which is exposed on port `80` and `443`. Data is persisted on `12Gi` of `ReadWriteOnce` volumes.
145
161
146
-
## Wrappers
162
+
## Wrappers <a id="wrappers"></a>
147
163
148
164
| Official wrapper | Repository | Features |
149
165
| --- | --- | --- |
@@ -168,15 +184,15 @@ This k8s setup creates all k8s resources inside the _Namespace_ `pokeapi`, run `
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!
174
190
175
191
Thank you to all our backers! [Become a backer](https://opencollective.com/pokeapi#backer)
0 commit comments