diff --git a/README.md b/README.md index a15b82f6..4d3d4ec3 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,13 @@ const core = new BurnerCore({ Are you a developer, hoping to test changes to other modules in this project (modern-ui, ui-core or various plugins)? -Run `yarn start-local` in the project root. This will start a wallet on localhost:3000 that is connected to your local +In the project root, run these commands: +``` +yarn install +yarn run build +yarn start-local +``` +This will start a wallet on http://localhost:3000 that is connected to your local Ganache instance (connecting to node http://localhost:8545 by default). Before the wallet server launches, a script create a pre-filled account. This account will hold 1 Ganache ETH and 100 diff --git a/local-wallet/README.md b/local-wallet/README.md index c4c437f5..9982bc7e 100644 --- a/local-wallet/README.md +++ b/local-wallet/README.md @@ -1,7 +1,7 @@ +This sample relies on packages in the root Burner-wallet-2 folder. Before using this make sure you build the dependencies, by running `yarn run build` in the root Burner-wallet-2 folder. + ## Scripts `yarn start`: Run the local script, then start the wallet. The local script will transfer ETH into the wallet address if it has a balance of 0. `yarn start-wallet`: Start the wallet without the local script. - -`yarn install-all`: Runs `yarn install` in this package, and all local dependencies.