Skip to content

Commit

Permalink
docs(readme): Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kisscool-fr authored Nov 28, 2024
1 parent 83da659 commit 8a31dcd
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@

[![Build Status](https://github.com/kisscool-fr/ghibliql/actions/workflows/main.yml/badge.svg?branch=master](https://github.com/kisscool-fr/ghibliql)
![Build Status](https://github.com/kisscool-fr/ghibliql/actions/workflows/main.yml/badge.svg?branch=master)

# GhibliQL

GhibliQL is a [GraphQL](http://graphql.org/) wrapper to the [Studio Ghibli REST API](https://ghibliapi.vercel.app)

## Build & run
## Build & Run

GhibliQL runs locally in Docker.
GhibliQL runs locally in Docker, there is a Makefile to help you:

1. `make pull`: pull httpd and redis docker images
2. `make build`: build the php image
3. `make prod`: download the minimum PHP packages
4. `make run`: run the server locally
| command | description |
| ------------ | -------------------------------------- |
| `make pull` | pull `httpd` and `redis` docker images |
| `make build` | build the `php` image |
| `make prod` | download the minimum PHP packages |
| `make dev` | download the optional PHP packages |
| `make run` | run the server locally, on port 8080 |

## Usage

First, you'll need a GraphQL client to query GhibliQL, like [Insomnia](https://insomnia.rest/) or [GraphQL IDE](https://github.com/redound/graphql-ide)

, you just have to build & launch with `make run`, then configure your GraphQL client to use the endpoint http://localhost:8080
Then, launch the server with `make run`, then configure your GraphQL client to use the endpoint `http://localhost:8080`

Then, you'll be able to explore the API using "easy-to-understand" GraphQL query.
Finally, you'll be able to explore the API using "easy-to-understand" GraphQL query.

For example, if I want the full list of films title, director, and characters name:
```
Expand Down

0 comments on commit 8a31dcd

Please sign in to comment.