Skip to content

Commit 3876911

Browse files
committed
updated README with Table Of Contents
1 parent fbb24bf commit 3876911

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,23 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
2020

2121
> Beta GraphQL support is rolling out! Check out the [GraphQL paragraph](#graphql--) for more info.
2222
23-
## Setup   [![pyVersion310](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/download/releases/3.10/)
23+
24+
## Table of Contents
25+
26+
1. [Setup](#setup)
27+
2. [Database Setup](#database-setup)
28+
3. [Docker and Compose](#docker-and-compose)
29+
4. [GraphQL](#graphql)
30+
5. [Kubernetes](#kubernetes)
31+
6. [Wrappers](#wrappers)
32+
7. [Donations](#donations)
33+
8. [Join Us On Slack!](#join-us-on-slack)
34+
9. [Contributing](#contributing)
35+
10. [Deprecation](#deprecation)
36+
37+
38+
39+
## Setup <a id="setup"></a> &nbsp; [![pyVersion310](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/download/releases/3.10/)
2440

2541
- Download this source code into a working directory, be sure to use the flag `--recurse-submodules` to clone also our submodules.
2642

@@ -43,7 +59,7 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
4359
make serve
4460
```
4561

46-
### Database setup
62+
## Database setup <a id="database-setup"></a>
4763

4864
To build or rebuild the database by applying any CSV file update, run
4965

@@ -70,7 +86,7 @@ make migrate
7086

7187
Run `make help` to see all tasks.
7288

73-
## Docker and Compose &nbsp; [![docker hub](https://img.shields.io/docker/v/pokeapi/pokeapi?label=tag&sort=semver)](https://hub.docker.com/r/pokeapi/pokeapi)
89+
## Docker and Compose <a id="docker-and-compose"></a> &nbsp; [![docker hub](https://img.shields.io/docker/v/pokeapi/pokeapi?label=tag&sort=semver)](https://hub.docker.com/r/pokeapi/pokeapi)
7490

7591
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.
7692

@@ -103,7 +119,7 @@ make docker-make-migrations
103119
make docker-migrate
104120
```
105121
106-
## GraphQL &nbsp; <a href="ttps://github.com/hasura/graphql-engine"><img height="29px" src="https://graphql-engine-cdn.hasura.io/img/powered_by_hasura_blue.svg"/></a>
122+
## GraphQL <a id="graphql"></a> &nbsp; <a href="ttps://github.com/hasura/graphql-engine"><img height="29px" src="https://graphql-engine-cdn.hasura.io/img/powered_by_hasura_blue.svg"/></a>
107123
108124
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
109125

@@ -119,7 +135,7 @@ A free public GraphiQL console is browsable at the address https://beta.pokeapi.
119135

120136
A set of examples is provided in the directory [/graphql/examples](./graphql/examples) of this repository.
121137

122-
## Kubernetes &nbsp; [![Build Docker image and create k8s with it](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml/badge.svg)](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml)
138+
## Kubernetes <a id="kubernetes"></a> &nbsp; [![Build Docker image and create k8s with it](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml/badge.svg)](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml)
123139

124140
[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:
125141

@@ -143,7 +159,7 @@ kubectl wait --namespace pokeapi --timeout=120s --for=condition=complete job/loa
143159

144160
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.
145161

146-
## Wrappers
162+
## Wrappers <a id="wrappers"></a>
147163

148164
| Official wrapper | Repository | Features |
149165
| --- | --- | --- |
@@ -168,15 +184,15 @@ This k8s setup creates all k8s resources inside the _Namespace_ `pokeapi`, run `
168184
|Swift |[kinkofer/PokemonAPI](https://github.com/kinkofer/PokemonAPI)| |
169185
|Typescript server-side/client-side|[Gabb-c/Pokenode-ts](https://github.com/Gabb-c/pokenode-ts)|Auto caching |
170186

171-
## Donations
187+
## Donations <a id="donations"></a>
172188

173189
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!
174190
175191
Thank you to all our backers! [Become a backer](https://opencollective.com/pokeapi#backer)
176192
177193
<a href="https://opencollective.com/pokeapi#backers" target="_blank"><img src="https://opencollective.com/pokeapi/backers.svg?width=890"></a>
178194
179-
## Join Us On Slack!
195+
## Join Us On Slack! <a id="join-us-on-slack"></a>
180196
181197
> **Warning**
182198
> Currently no maintainer has enough free time to support the community on Slack. Our Slack is in an unmaintained status.
@@ -188,7 +204,7 @@ This way we can keep issues here a bit more organized and helpful in the long ru
188204
189205
Once you've signed up visit [PokéAPI on Slack](https://pokeapi.slack.com)
190206

191-
## Contributing
207+
## Contributing <a id="contributing"></a>
192208

193209
This project exists thanks to all the people who [contribute](https://github.com/PokeAPI/pokeapi/blob/master/CONTRIBUTING.md)
194210

@@ -224,6 +240,6 @@ To contribute to this repository:
224240
225241
Simple!
226242
227-
## Deprecation
243+
## Deprecation <a id="deprecation"></a>
228244
229245
As of October 2018, the v1 API has been removed from PokéAPI. For more information, see [pokeapi.co/docs/v1.html](https://pokeapi.co/docs/v1.html).

0 commit comments

Comments
 (0)