Skip to content

Commit

Permalink
chore: add developer instructions (#55)
Browse files Browse the repository at this point in the history
Signed-off-by: Lenin Mehedy <[email protected]>
leninmehedy authored Feb 27, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent fd0ee4b commit c341ddc
Showing 2 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions .remarkrc.yml
Original file line number Diff line number Diff line change
@@ -3,6 +3,7 @@ plugins:
- remark-preset-lint-consistent
# Few recommended rules.
- remark-preset-lint-recommended
- remark-lint-maximum-line-length: 120
# list item indentation should be space
- - remark-lint-list-item-indent
- space
25 changes: 25 additions & 0 deletions DEV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Developer instructions

Below we describe how you can set up local environment and contribute to `solo`.

* Clone the repo
* In order to support ES6 modules with `jest`, set an env variable `NODE_OPTIONS` as below:
* `export NODE_OPTIONS=--experimental-vm-modules >> ~/.zshrc`
* For Intellij users: enable `--experimental-vm-modules` for `Jest` as below:
* Go to: `Run->Edit Configurations->Edit Configuration Templates->Jest`
* Set: `--experimental-vm-modules` in `Node Options`.
* Run `npm i` to install the required packages
* Run `npm link` to install `solo` as the CLI
* Note: you need to do it once. If `solo` already exists in your path, you will need to remove it first.
* Alternative way would be to run `npm run solo -- <COMMAND> <ARGS>`
* Run `npm test` or `npm run test` to run the unit tests
* Run `solo` to access the CLI.
* Note that debug logs are stored at `$HOME/.solo/logs/solo.log`.
* So you may use `tail -f $HOME/.solo/logs/solo.log | jq` in a separate terminal to keep an eye on the logs.
* Before making a commit run `npm run format`

## E2E tests

* In order to run E2E test, we need to set up cluster and install the chart.
* Run `./test/e2e/setup-e2e.sh`
* Run `npm run test-e2e`

0 comments on commit c341ddc

Please sign in to comment.