Remix

Remix (aka. Browser-Solidity) is a browser-based Solidity compiler and IDE.

Visit https://remix.ethereum.org to use; it will always deliver the latest version.

Offline Usage

The gh-pages branch always has the latest stable build of Remix. It also contains a ZIP file with the entire build. Download it to use offline.

Note: it contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported.

INSTALLATION:

Install npm and node.js (see https://docs.npmjs.com/getting-started/installing-node), then do:

• git clone https://github.com/ethereum/browser-solidity
• cd browser-solidity
• npm install - fetch dependencies & executes npm run prepublish to build the application

DEVELOPING:

Run npm start and open http://127.0.0.1:8080 in your browser.

Then open your text editor and start developing. The browser will automatically refresh when files are saved

It is also possible to run npm run build && npm run serve but the web application will not automatically refresh.

Most of the the time, working with the remix repository is not necessary. But in case changes have to be made in remix too, the following command links remix to you local dev repository:

after npm install

npm run pullremix

npm run linkremixcore

npm run linkremixlib

npm run linkremixsolidity

npm run linkremixdebugger

Troubleshooting building

Here are some things to consider if you have trouble building the package.

• Make sure that you have the correct version of node, npm and nvm. You can find the version that is tested on Travis CI by looking at the log in the build results.

Run:

node --version
npm --version
nvm --version

• In Debian based OSes such as Ubuntu 14.04LTS you may need to run apt-get install build-essential. After installing build-essential run npm rebuild.

Unit Testing

Register new unit test files in test/index.js. The tests are written using tape.

Run the unit tests via: npm test

For local headless browser tests run npm run test-browser (Requires selenium to be installed - can be done with npm run selenium-install)

Running unit tests via npm test requires at least node v7.0.0

Browser Testing

To run the Selenium tests via Nightwatch serve the app through a local web server:

npm run serve # starts web server at localhost:8080

Then you will need to either:

1. Have a Selenium server running locally on port 4444.
   • Run: npm run test-browser
2. Or, install and run SauceConnect.
   • Run: sc -u <USERNAME> -k <ACCESS_KEY> (see .travis.yml for values)
   • Run: npm run browser-test-sc

Usage as a Chrome Extension

If you would like to use this as a Chrome extension, you must either build it first or pull from the gh-pages branch, both described above. After that, follow these steps:

• Browse to chrome://extensions/
• Make sure 'Developer mode' has been checked
• Click 'Load unpacked extension...' to pop up a file-selection dialog
• Select your browser-solidity folder