From b4b4b9670b23762decc38b02b8e9a7512e702561 Mon Sep 17 00:00:00 2001 From: Aditya Konarde Date: Wed, 24 Jul 2019 14:35:24 +0200 Subject: [PATCH] Restructure readme, create bundle before run (#46) If someone is reading from top-bottom, its hard to notice that you need to create the bundle BEFORE you attempt to run the GraphQL server. This is a minor fix but hopefully avoids confusion for future developers. --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 37ac5e9..c525461 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ An example of an implementation reconcile tools can be obtained from here: [http ## Development Environment +### Setting up yarn + Although it is not required, it's recommended that you use [yarn] for install dependencies and running development scripts. @@ -45,6 +47,19 @@ Or alternatively, you can run the TypeScript compilation once: ```sh yarn build ``` +### Creating and validating the bundle + +The data files bundle is required to start the server. Once you're in the `qontract-server` directory, run: + +```sh +make bundle +``` +Note that this requires Docker to be running on the host. + +Optionally, if you want to specify the path for the app-interface repo on your local filesystem, you can use the parameter: +* `APP_INTERFACE_PATH` - (optional) path to a local app-interface repo (Default: `$PWD/../../service/app-interface`). + +### Running the Qontract GraphQL server To run an instance of the qontract GraphQL console: @@ -75,16 +90,6 @@ yarn build # Start the server make run ``` -## Creating and validating the bundle - -The bundle is required to start the server. - -```sh -make bundle -``` - -* `APP_INTERFACE_PATH` - (optional) path to a local app-interface repo (Default: `$PWD/../../service/app-interface`). - ## Style All code should follow the [airbnb style guide], which is enforced by this