|
1 | 1 | # safe_browser |
2 | 2 |
|
3 | | -> SAFE Browser is a browser designed to open safe:// websites on the SAFE Network. |
| 3 | +A browser designed to open `safe://` websites on the SAFE Network. |
4 | 4 |
|
5 | 5 | **Maintainer:** Krishna Kumar (krishna.kumar@maidsafe.net) |
6 | 6 |
|
7 | 7 | ## Development |
8 | 8 |
|
9 | | -### Prerequisites |
| 9 | +1. Prerequisites: |
10 | 10 |
|
11 | | - * Node.js 6.5.0 (we recommend installing it via [nvm](https://github.com/creationix/nvm)) |
12 | | - * [Git](https://git-scm.com/) |
13 | | - * [Yarn](https://yarnpkg.com) (as a replacement for `npm`). |
| 11 | + * Node.js 6.5.0 (we recommend installing it via [nvm](https://github.com/creationix/nvm)) |
| 12 | + * [Git](https://git-scm.com/) |
| 13 | + * [Yarn](https://yarnpkg.com) (as a replacement for `npm`). |
14 | 14 |
|
15 | | - |
16 | | -1. Clone this GitHub repository. |
| 15 | +2. Clone this GitHub repository: |
17 | 16 |
|
18 | 17 | ```bash |
19 | | - $ git clone https://github.com/maidsafe/safe_browser.git |
| 18 | + git clone https://github.com/maidsafe/safe_browser.git |
20 | 19 | ``` |
21 | 20 |
|
22 | | -2. Install the dependencies. |
| 21 | +3. Install the dependencies: |
23 | 22 |
|
24 | 23 | ``` bash |
25 | | - $ cd safe_browser |
26 | | - $ yarn |
| 24 | + cd safe_browser |
| 25 | + yarn |
27 | 26 | ``` |
28 | 27 |
|
29 | | - If you are working on a development environment, you can run `NODE_ENV=dev yarn` instead in order to get the `safe_client` libraries which use the `MockVault` file rather than connecting to the SAFE Network. |
| 28 | + If you're actively developing, you can run `NODE_ENV=dev yarn` instead in order to get the `safe_client` libraries which use the `MockVault` file rather than connecting to the SAFE Network. |
30 | 29 |
|
31 | | -3. Build SAFE Browser and open it. |
| 30 | +4. Build the SAFE Browser and open it: |
32 | 31 |
|
33 | | - ``` |
34 | | - $ yarn run build |
35 | | - $ yarn start |
| 32 | + ```bash |
| 33 | + yarn run build |
| 34 | + yarn start |
36 | 35 | ``` |
37 | 36 |
|
38 | | - If you're doing development, `yarn run watch` to have assets build automatically. |
| 37 | + If you're actively developing, you can use `yarn run watch` to have assets built automatically when they change. |
39 | 38 |
|
40 | | -6. Package SAFE Browser. |
| 39 | +5. Package the SAFE Browser for production: |
41 | 40 |
|
42 | | - ``` |
43 | | - $ yarn run package |
| 41 | + ```bash |
| 42 | + yarn run package |
44 | 43 | ``` |
45 | 44 |
|
46 | 45 | The packed SAFE Browser will be found inside `dist` folder. |
47 | 46 |
|
48 | | -### Updating |
| 47 | +### Troubleshooting |
49 | 48 |
|
50 | | -If you pull latest from the repo and get weird module errors, do: |
| 49 | +If you pull the latest from the repo and get weird module errors, try: |
51 | 50 |
|
52 | 51 | ```bash |
53 | | -$ yarn run burnthemall |
| 52 | +yarn run burnthemall |
54 | 53 | ``` |
55 | 54 |
|
56 | | -This will remove your node_modules, and do the full install, rebuild, build SAFE Authenticator and package processes for you. `yarn start` should work afterwards. |
| 55 | +This will remove your `node_modules` and do the full install, rebuild, build SAFE Authenticator, and package processes for you. After this, `yarn start` should work again. |
| 56 | + |
| 57 | +## Further Help |
| 58 | + |
| 59 | +You can discuss development-related questions on the [SAFE Dev Forum](https://forum.safedev.org/). |
| 60 | +Here's a good post to get started: [How to develop for the SAFE Network](https://forum.safedev.org/t/how-to-develop-for-the-safe-network-draft/843). |
57 | 61 |
|
58 | 62 | ## License |
59 | 63 |
|
|
0 commit comments