safe_browser

A browser designed to open safe:// websites on the SAFE Network.

Maintainer: Krishna Kumar (krishna.kumar@maidsafe.net)

Development

1. Prerequisites:

   • Node.js ^8.0.0 (we recommend installing it via nvm)
   • Git
   • Yarn (as a replacement for npm).
   • Python

2. Clone this GitHub repository:

   git clone https://github.com/maidsafe/safe_browser.git

3. Install the dependencies:

   cd safe_browser
   yarn

   If you're actively developing, you can run yarn mock instead of yarn in order to get the safe_client libraries which use the MockVault file rather than connecting to the SAFE Network.

   Windows-specific notes:

   • yarn will attempt to use multiple processes to speed up installation, which will cause errors on Windows. So, before running yarn or yarn mock, run yarn config set child-concurrency 1.

4. Build the SAFE Browser and open it:

   yarn run build
   yarn start

   If you're actively developing, you can use yarn run watch to have assets built automatically when they change.

5. Package the SAFE Browser for production:

   yarn run package

   The packed SAFE Browser will be found inside dist folder. In order to be able to connect to the live SAFE Network, a crust.config file shall be placed in the same path of the browser executable. You can find a copy of the crust.config file at build/SAFE Browser.crust.config and copy it onto dist/safe-browser-<version>-<platform>/<safe browser exec name>.crust.config.

Troubleshooting

If you pull the latest from the repo and get weird module errors, try:

yarn run burnthemall

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.

Further Help

You can discuss development-related questions on the SAFE Dev Forum. Here's a good post to get started: How to develop for the SAFE Network.

License

SAFE Browser is a lightly modified fork of the Beaker Browser.

Modified MIT as per the BeakerLicense.

This is dual-licensed under the Modified BSD (LICENSE-BSD https://opensource.org/licenses/BSD-3-Clause) or the MIT license (LICENSE-MIT https://opensource.org/licenses/MIT) at your option.