Laptop and Desktop browser for OS X, Windows and Linux.

1. Shallow clone the git repository from GitHub:

    # For beta testers:
    git clone --depth 1 https://github.com/brave/browser-laptop
    
    # For devs over HTTPS:
    git clone https://github.com/brave/browser-laptop
   
    # For devs over SSH:
    git clone git@github.com:brave/browser-laptop.git
   

2. Open the working directory:

    cd browser-laptop
   

3. Install the Node dependencies:

    npm install
   

To start the server and file watchers run the following on the command line:

npm run watch

To run the browser:

npm start

To run the tests:

npm run watch-test  or  npm run watch-all

npm test

See docs/debugging.md for information on debugging.

We are using a fork of Electron with some minor modifications here: https://github.com/brave/electron

Most of the time you will not need to use that repository, we provide pre-built binaries when you npm install with our own fork of electron-prebuilt.

If you want to add code to Electron itself, then you may want to build it. An example would be exposing a new event to the webview from Electron. We try to upstream everything to atom/electron but we can take things in our fork early before upstreaming.

Build instructions:

• OSX build instructions
• Windows build instructions
• Linux build instructions

From within brave-browser you can create a .app file for distribution:

npm run build-darwin

After the .app file is built you can create a dmg with:

npm run installer-darwin

Prerequisite: You must have NSIS installed.

To create a folder with the app .exe and all dependencies:

npm run build-win64

After the above folder is created, you can create an NSIS based installer with:

npm run installer-win64

Packaging is not implemented yet for other platforms, but it would be simple for linux.

Development builds will automatically open developer tools within the browser.