-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
60dcd10
commit 11fc0ba
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |