Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

updated README with Table Of Contents #1155

Merged
merged 2 commits into from
Oct 31, 2024
Merged

updated README with Table Of Contents #1155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3876911
updated README with Table Of Contents
27Jashshah Oct 28, 2024
30f384f
Removed unnecessary <a> tags from headers for ToC
27Jashshah Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,21 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)

> Beta GraphQL support is rolling out! Check out the [GraphQL paragraph](#graphql--) for more info.

## Setup &nbsp; [![pyVersion310](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/download/releases/3.10/)

## Table of Contents

- [Setup   ](#setup)
- [Database setup](#database-setup)
- [Docker and Compose   ](#docker-and-compose)
- [GraphQL   ](#graphql)
- [Kubernetes   ](#kubernetes)
- [Wrappers](#wrappers)
- [Donations](#donations)
- [Join Us On Slack!](#join-us-on-slack)
- [Contributing](#contributing)
- [Deprecation](#deprecation)

## 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/)

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

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

### Database setup
## Database setup

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

Expand All @@ -70,7 +84,7 @@ make migrate

Run `make help` to see all tasks.

## 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)
## 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)

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.

Expand Down Expand Up @@ -103,7 +117,7 @@ make docker-make-migrations
make docker-migrate
```

## 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>
## 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>

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

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

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

## 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)
## 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)

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

Expand Down