maniacs-oss / safe_browser

SAFE Browser Application

safe_browser

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

Maintainer: Krishna Kumar ([email protected])

Development

1. Prerequisites:

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

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 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.

   Windows-specific notes:

   • yarn will attempt to use multiple processes to speed up installation, which will cause errors on Windows. So, before running yarn, run yarn config set child-concurrency 1.
   • You'll notice that you can't run NODE_ENV=dev yarn in command prompt or PowerShell. Instead, before running yarn, run $env:NODE_ENV = "dev" in PowerShell or set NODE_ENV=dev in command prompt. Both of which will only last as variables for the duration of that shell session.

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.

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