Add more information to development process

README.md

@@ -1,11 +1,13 @@
 # qontract-server
 
-qontract (Queryable cONTRACT) is a collection of tools used to SREs to expose available managed services to application developer teams.
-This repository compromises the server component, which is implemented as a GraphQL API.
+qontract (Queryable cONTRACT) is a collection of tools used to SREs to expose
+available managed services to application developer teams. This repository
+compromises the server component, which is implemented as a GraphQL API.
 
 ## Development Environment
 
-Although it is not required, it's recommended that you use [yarn] for install dependencies and running development scripts.
+Although it is not required, it's recommended that you use [yarn] for install
+dependencies and running development scripts.
 
 [yarn]: https://yarnpkg.com
 
@@ -15,10 +17,16 @@ To install this projects dependencies to a local `node_modules` directory:
 yarn install
 ```
 
-To run a process that watches for edits and rebuilds JavaScript:
+To run a process that watches for edits and rebuilds JavaScript from TypeScript:
 
 ```sh
-yarn run dev
+yarn run watch
+```
+
+Or alternatively, you can run the TypeScript compilation once:
+
+```sh
+yarn build
 ```
 
 To run an instance of the qontract GraphQL console:
@@ -27,10 +35,60 @@ To run an instance of the qontract GraphQL console:
 LOAD_METHOD=fs DATAFILES_FILE=your_test_datafile yarn run server
 ```
 
-All code should follow the [airbnb style guide], which is enforced by this projects lint script:
+Specific instructions for CentOS 7:
+
+```sh
+# Install node10
+sudo yum install centos-release-scl-rh
+sudo yum install rh-nodejs10
+
+# Install yarn (as root)
+scl enable rh-nodejs10 bash
+npm install -g yarn
+
+# Enable node10 (as user in qontract-server git repo)
+scl enable rh-nodejs10 bash
+
+# Install qontract-server yarn modules
+yarn install
+
+# Build the JavaScript
+yarn build
+
+# Start the server
+LOAD_METHOD=fs DATAFILES_FILE=<data-bundle-json> yarn run server
+```
+## Creating the data and schema bundles
+
+The bundles are required to run the validation and to start the server.
+
+```sh
+docker pull quay.io/app-sre/qontract-validator:latest
+docker run --rm -v $DATA_DIR:/data:z quay.io/app-sre/qontract-validator:latest qontract-bundler /data > data.json
+docker run --rm -v $SCHEMAS_DIR:/schemas:z quay.io/app-sre/qontract-validator:latest qontract-bundler /schemas > schemas.json
+```
+
+As of right now, the `$SCHEMAS_DIR` is `assets/schemas/` dir in the
+`qontract-server` git repository, although in the future it will be removed from
+this repository.
+
+## Validating the data against the schemas
+
+```sh
+docker run --rm -v $BUNDLES_DIR:/bundles:z quay.io/app-sre/qontract-validator:latest qontract-validator --only-errors /bundles/schemas.json /bundles/data.json
+```
+
+The `$BUNDLES_DIR` is a directory that must contain the `data.json` and
+`schemas.json` file created in the previous section.
+
+## Style
+
+All code should follow the [airbnb style guide], which is enforced by this
+projects lint script:
 
 [airbnb style guide]: https://github.com/airbnb/javascript
 
 ```sh
 yarn run lint
 ```
+