Mirrors/pokeapi
2
0
Fork 0
mirror of https://github.com/PokeAPI/pokeapi synced 2024-11-25 21:00:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md commands

Browse source 
Added a line to describe how to apply CSV updates to a running instance
This commit is contained in:
Dalton 2024-01-21 08:55:21 -06:00 committed by GitHub
parent f78326c8e1
commit 1b5701afed
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -42,6 +42,7 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
```sh ```sh
make serve make serve
``` ```
This will serve on port `8000` by default.
### Database setup ### Database setup
@ -58,7 +59,7 @@ The option to build individual portions of the database was removed in order to
If you ever need to wipe the database use this command: If you ever need to wipe the database use this command:
```sh ```sh
make wipe_db make wipe-sqlite-db
``` ```
## Docker and Compose   [![docker hub](https://img.shields.io/docker/v/pokeapi/pokeapi?label=tag&sort=semver)](https://hub.docker.com/r/pokeapi/pokeapi) ## Docker and Compose   [![docker hub](https://img.shields.io/docker/v/pokeapi/pokeapi?label=tag&sort=semver)](https://hub.docker.com/r/pokeapi/pokeapi)
@ -81,6 +82,11 @@ docker-compose exec -T app sh -c 'echo "from data.v2.build import build_all; bui
Browse [localhost/api/v2/](http://localhost/api/v2/) or [localhost/api/v2/pokemon/bulbasaur/](http://localhost/api/v2/pokemon/bulbasaur/) on port `80`. Browse [localhost/api/v2/](http://localhost/api/v2/) or [localhost/api/v2/pokemon/bulbasaur/](http://localhost/api/v2/pokemon/bulbasaur/) on port `80`.
To rebuild the Docker database and apply any CSV file updates, run
```sh
make docker-build-db
```
## 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 &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 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