Skip to content

Commit

Permalink
Merge pull request #237 from energywebfoundation/TASK/ICL-68/creating…
Browse files Browse the repository at this point in the history
…-tech-doc

added setup.md
  • Loading branch information
JGiter committed Oct 1, 2021
2 parents 3a1194a + 716f827 commit c387f21
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

# setting up and testing project locally

to use/debug iam-client-lib locally you should

1. clone the repo to your local machine
2. run `npm link` on root directory after `npm i`
3. then in repo you are going to use the package(i.e. switchboard-dapp), in root directory run `npm link iam-client-lib`

after this steps when `npm run build` command will be executed the iam-client-lib will automatically be updated on switchboard-dapp.

# supported environment

for unix and windows environments lib is executing `npm i` and `npm run build` without problems

but `npm run test:watch` throws error with message `cannot find ganache-cli` on `windows` environment. on linux ones its workng fine.
doing `npm i -g ganache-cli` does not help here. this needs further investigation.

0 comments on commit c387f21

Please sign in to comment.