@@ -52,13 +52,14 @@ To validate your downloaded file's integrity, compare the lines in checksum.txt
53### Install / Build
53### Install / Build
55+Clone the repo, and use a simple `npm install`. You can then use a `npm run
55−Clone the repo, and use a simple `npm install`. You can then use a `npm run build` to create an optimised static build (serve it with e.g. [serve][serv]).
56+build` to create an optimised static build (serve it with e.g. [serve][serv]).
57### General notes
58### General notes
59−For development, use `npm run pilot` to get going after a `npm install`. This
60+For development, use `npm run pilot` to get going after a `npm install`. This
60will boot up a Ganache node in the background, deploy the Azimuth contracts to
61will boot up a Ganache node in the background, deploy the Azimuth contracts to
61−it, and fire up a local webserver. Bridge will be served on `localhost:3000`.
62+it, and fire up a local webserver. Bridge will be served on `localhost:3000`.
63Note that one of our dependencies itself depends on a library called
64Note that one of our dependencies itself depends on a library called
64`handle-thing` which breaks under the Ledger support requirements (see below)
65`handle-thing` which breaks under the Ledger support requirements (see below)
@@ -76,7 +77,7 @@ before running `npm run pilot`.
76### Useful accounts
77### Useful accounts
78The ecliptic owner is the only account that's able to create galaxies, so
79The ecliptic owner is the only account that's able to create galaxies, so
79−it's a good place to get started. On the testnet, it's the address:
80+it's a good place to get started. On the testnet, it's the address:
820x6DEfFb0caFDB11D175F123F6891AA64F01c24F7d
830x6DEfFb0caFDB11D175F123F6891AA64F01c24F7d
@@ -113,15 +114,12 @@ You can also tweak a couple of things to change your development state
113somewhat (say, for example, you want to start on the points list screen, instead
114somewhat (say, for example, you want to start on the points list screen, instead
114of having to re-authenticate whenever you make a change or refresh the page):
115of having to re-authenticate whenever you make a change or refresh the page):
116−- The `.env.development` file contains environment variables that you can
117+* The `.env.development` file contains environment variables that you can
117− provide to the application when it's running in development. You can access
118+ provide to the application when it's running in development. You can access
118 them via `process.env.REACT_APP_<whatever>`.
119 them via `process.env.REACT_APP_<whatever>`.
120−- Make `REACT_APP_STUB_LOCAL='true'` to enabled stubbing of some methods
121− in a local development environment.
123−- The top of the Bridge component in `src/Bridge.js`
121+* The `componentDidMount` method of the Bridge component in `src/Bridge.js`
124− can be tweaked for setting your initial state. You can provide a specific
122+ can be tweaked for setting your initial state. You can provide a specific
125 wallet, network type, and so on.
123 wallet, network type, and so on.
@@ -138,14 +136,15 @@ websocket. Do this by going to `about:config` and setting the
138`network.websocket.allowInsecureFromHTTPS` flag to `true`.
136`network.websocket.allowInsecureFromHTTPS` flag to `true`.
140Additionally you need to run with the `HTTPS` environment variable set to
138Additionally you need to run with the `HTTPS` environment variable set to
141−`true`. Note that `npm run pilot` will handle this automatically.
139+`true`. Note that `npm run pilot` will handle this automatically.
143### Releases
141### Releases
145−To generate a release `bridge-$VERSION.zip` file, use a simple `npm run release`.
143+To generate a release `bridge-$VERSION.zip` file, use a simple `npm run
147This will pack the build directory together with the README, `bridge-https.py`
146This will pack the build directory together with the README, `bridge-https.py`
148−script, and also generate a set of checksums for the build directory. You can
147+script, and also generate a set of checksums for the build directory. You can
149verify the checksums on e.g. OS X via `shasum -c checksums.txt`.
148verify the checksums on e.g. OS X via `shasum -c checksums.txt`.
151[rele]: https://github.com/urbit/bridge/releases/latest
150[rele]: https://github.com/urbit/bridge/releases/latest