Skip to content

Commit b579978

Browse files
authored
Merge pull request #1155 from 27Jashshah/table_of_contents
updated README with Table Of Contents
2 parents fbb24bf + 30f384f commit b579978

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,21 @@ 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+
- [Setup   ](#setup)
27+
- [Database setup](#database-setup)
28+
- [Docker and Compose   ](#docker-and-compose)
29+
- [GraphQL   ](#graphql)
30+
- [Kubernetes   ](#kubernetes)
31+
- [Wrappers](#wrappers)
32+
- [Donations](#donations)
33+
- [Join Us On Slack!](#join-us-on-slack)
34+
- [Contributing](#contributing)
35+
- [Deprecation](#deprecation)
36+
37+
## 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/)
2438

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

@@ -43,7 +57,7 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
4357
make serve
4458
```
4559

46-
### Database setup
60+
## Database setup
4761

4862
To build or rebuild the database by applying any CSV file update, run
4963

@@ -70,7 +84,7 @@ make migrate
7084

7185
Run `make help` to see all tasks.
7286

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)
87+
## 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)
7488

7589
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.
7690

@@ -103,7 +117,7 @@ make docker-make-migrations
103117
make docker-migrate
104118
```
105119
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>
120+
## 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>
107121
108122
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
109123

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

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

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)
136+
## 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)
123137

124138
[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:
125139

0 commit comments

Comments
 (0)