Skip to content

Commit

Permalink
Update Readme with Yarn version requirement (polkadot-js#100)
Browse files Browse the repository at this point in the history
To avoid issues with installation it is necessary to install a compatible version of Yarn.
It was highlighted [here](polkadot-js#78) that Yarn 1.0 included workspaces, and we are successfully using Yarn 1.3.2 for Travis CI, so propose to request users to ensure they are using a version later than that to avoid and problems.
For instance, I was using Yarn 0.24.6 and it [wouldn't install the sub-package dependencies](polkadot-js#78) nor would it [run a necessary binary](polkadot-js#98), but after upgrading to Yarn 1.7.0 those issues were resolved.
  • Loading branch information
ltfschoen authored and jacogr committed Jun 19, 2018
1 parent 875275c commit 5277cf0
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,11 @@ To start off, this repo (along with others in the [@polkadot](https://github.com
To get started -

1. Clone the repo locally, via `git clone https://github.com/polkadot-js/apps <optional local path>`
2. Ensure that you have a recent version of `node.js`, for development purposes [Node 10](https://nodejs.org/en/) is recommended.
3. Install the dependencies via `yarn` (If you don't have yarn available, install via [options for your environment](https://yarnpkg.com/en/docs/install))
4. Ready! Now you can launch the UI (assuming you have a local Polkadot Node running), via `yarn run start`
5. Access the UI via [http://localhost:3000](http://localhost:3000)
2. Ensure that you have a recent version of Node.js, for development purposes [Node 10](https://nodejs.org/en/) is recommended.
3. Ensure that you have a recent version of Yarn, for development purposes [Yarn >=1.3.2](https://yarnpkg.com/docs/install) is required.
4. Install the dependencies by running `yarn`
5. Ready! Now you can launch the UI (assuming you have a local Polkadot Node running), via `yarn run start`
6. Access the UI via [http://localhost:3000](http://localhost:3000)

Alternatively, should you not have a local Node, you can connect to a remote node (POC-1 network, although not fully up-to-date with features) with the `WS_URL` parameter. For eample - the apps entry point can be launched with a WebSocket connection to Polkadot PoC-1 with `WS_URL=wss://poc-1.polkadot.io:9944 yarn run start` and accessing the application of [http://localhost:3000](http://localhost:3000)

Expand Down

0 comments on commit 5277cf0

Please sign in to comment.