-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
1 parent
30cc977
commit 88c064c
Showing
1 changed file
with
56 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,56 @@ | ||
# Config | ||
|
||
### Pre-requisites | ||
|
||
Install dependencies for the workspace | ||
|
||
```bash | ||
yarn install | ||
``` | ||
|
||
### Quick Start Guide | ||
|
||
All commands below need to be run in the context of the `config` package where this README is located. Read more about context [here](../../../README.md#context). | ||
|
||
Running in `dev` mode: | ||
|
||
```bash | ||
yarn dev | ||
``` | ||
|
||
Building to `./dist` directory with javascript output: | ||
|
||
```bash | ||
yarn build | ||
``` | ||
|
||
Running all tests: | ||
|
||
```bash | ||
yarn test | ||
``` | ||
|
||
Running changed tests in watch mode: | ||
|
||
```bash | ||
yarn test:watch | ||
``` | ||
|
||
Linting: | ||
|
||
```bash | ||
yarn lint | ||
``` | ||
|
||
Typechecking: | ||
|
||
```bash | ||
yarn typecheck | ||
``` | ||
|
||
|
||
### About | ||
|
||
This package contains the configuration class that can be used to create a new configuration object that is then passed into the Typescript SDK when an external consumer initializes it. It also contains the configuration types, enums, utility functions that are used to assist with the setup of this configuration object. | ||
|
||
[Read more about the config package here](../../README.md#config) |