Skip to content

Commit

Permalink
Restructure readme, create bundle before run (#46)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Aditya Konarde authored Jul 24, 2019
1 parent 634ef81 commit b4b4b96
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit b4b4b96

Please sign in to comment.