Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rspurgeon authored Jul 11, 2023
1 parent cd9b69d commit fcb32d6
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions experience/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,23 @@ applications.
* npm (tested with version 8.11.0)
* Nodemon for dev servers (tested with version 2.0.22)

This GraphQL service depends on the following KongAir REST API services, as they
provide the upstream data source for the experience API. By default, the
`.env` file in this folder configures the upstream REST APIs to be serviced by
a hosted version of this application at `api.kong-air.com`. If you would like to
run a local version of these services, see the [run-all.sh](../run-all.sh)
script in the parent directory. You'll also need to change the configured in the
[.env](.env) file to point to the localhost versions of the upstream services.

Each upstream REST API and the GraphQL server accept configurations
using `dotenv` (see the `.env` file in each repository).

See:
* [Routes](../flight-data/routes/README.md)
* [Flights](../flight-data/flights/README.md)
* [Customer](../sales/customer/README.md)
* [Bookings](../sales/bookings/README.md)

## Server Usage

To install dependencies:
Expand All @@ -27,18 +44,6 @@ For an auto-reloading dev server:
npm run dev
```

This GraphQL service depends on the following KongAir REST API services, as they
provide the upstream data source for the experience API.
In order for the experience API to work, you will need to have each of the
KongAIR REST API services running on `localhost` on their well known port.
Alternatively, each REST API and the GraphQL server accept configurations
using `dotenv` (see the `.env` file in each repository).

See:
* [Routes](../flight-data/routes/README.md)
* [Flights](../flight-data/flights/README.md)
* [Customer](../sales/customer/README.md)
* [Bookings](../sales/bookings/README.md)

Once the server is running you can use the helper `query.sh` script, or you can
point a web browser at the Apollo Studio hosted on the server.
Expand Down

0 comments on commit fcb32d6

Please sign in to comment.