@onereach/types-hitl-api 0.0.5 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -40,12 +40,23 @@ DB_NAME=hitl-app-db
|
|
|
40
40
|
|
|
41
41
|
You can change all the values above, if you want to, just make sure that the variables in `.env` file point to some valid PostgreSQL instance.
|
|
42
42
|
|
|
43
|
+
#### Retrieving deploy config
|
|
44
|
+
|
|
45
|
+
Make sure you have `deploy-platform` project installed on your machine, and a command `or` is globally available.
|
|
46
|
+
|
|
47
|
+
Run the following commands:
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
or get-config --branch local --client development --env qa --feature master --project hitl-api --service hitl_api.config --service-or-eval service > config.json
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
A file `config.json`, which is ignored by git, should appear in the project root with some content.
|
|
54
|
+
|
|
43
55
|
#### Installing packages and starting the application
|
|
44
56
|
|
|
45
57
|
After installing third party dependencies, we can finally run:
|
|
46
58
|
|
|
47
59
|
```
|
|
48
|
-
echo "{ \"vars\": { \"SDK_API_URL\": \"\" } }" > config.json
|
|
49
60
|
npm install
|
|
50
61
|
npm start
|
|
51
62
|
```
|