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