Skip to content

Commit

Permalink
init basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jzelinskie committed Jan 21, 2019
1 parent 60dcd10 commit 11fc0ba
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 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.

## Development Environment

Although it is not required, it's recommended that you use [yarn] for install dependencies and running development scripts.

[yarn]: https://yarnpkg.com

To install this projects dependencies to a local `node_modules` directory:

```sh
yarn install
```

To run a process that watches for edits and rebuilds JavaScript:

```sh
yarn run dev
```

To run an instance of the qontract GraphQL console:

```sh
DATAFILES_FILE=your_test_datafile yarn run server
```

0 comments on commit 11fc0ba

Please sign in to comment.