Browser-Only Solidity IDE and Runtime Environment
Clone or download
Latest commit 4f22cde Nov 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci circle-ci cache Nov 14, 2018
assets update font awesome Jul 23, 2018
bin Update remix-ide Sep 13, 2018
ci provide remix ide URL Oct 1, 2018
contracts fix test Apr 23, 2018
embark update use of remixd in embark Sep 8, 2018
extensions/etherscan-general remove built extension API && move wrapper to root folder Jul 6, 2018
src Merge pull request #1543 from ethereum/refactor_debugger Nov 14, 2018
test-browser-debugger/test fix test Aug 22, 2018
test-browser try fixing tests Nov 14, 2018
test update compiler test Feb 1, 2018
.babelrc use babel-plugin-transform-object-assign Apr 20, 2017
.gitignore add poc test tab Jun 1, 2018
.npmignore fix deploy build folder to npm package Mar 15, 2018
.travis.yml remove downloadsolc + clean cache Aug 22, 2018
LICENSE.md Update copyright Jul 18, 2016
README.md Update README.md Nov 19, 2018
background.js Format using standard Oct 25, 2016
best-practices.md update example Feb 19, 2018
icon.png remix logo Jan 18, 2017
index.html remove unneeded css ref Oct 11, 2017
manifest.json fix loading compiler Mar 20, 2018
nightwatch.js fix remove instance May 15, 2018
nightwatch_debugger.js updatea IE version for tesing Mar 22, 2018
package.json Update package.json Nov 13, 2018
release-process.md Update release-process.md Jul 5, 2018
research-project.md Create research-project.md Aug 30, 2018
team-best-practices.md update requires to new remix libs Aug 22, 2018

README.md

CircleCI BrowserStack Status

Remix

Remix is a browser-based compiler and IDE that enables users to build Ethereum contracts with Solidity language and to debug transactions.

To try it out, visit https://remix.ethereum.org.

https://github.com/ethereum/remix-ide/releases also gives others ways to use Remix locally. Please check it out.

Remix consists of many modules and in this repository you will find the Remix IDE (aka. Browser-Solidity).

Remix screenshot

Offline Usage

The gh-pages branch has always 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:

Remix-ide has been published as an npm module:

npm install remix-ide -g
remix-ide

Or if you want to clone the github repository (wget need to be installed first) :

git clone https://github.com/ethereum/remix-ide.git
git clone https://github.com/ethereum/remix.git # only if you plan to link remix and remix-ide repositories and develop on it.
cd remix-ide
npm install
npm run setupremix  # only if you plan to link remix and remix-ide repositories and develop on it.
npm start

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.

Most of the the time working with other modules (like debugger etc.) hosted in the Remix repository is not needed.

Troubleshooting building

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 OS 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 remix-ide folder

Documentation

To see details about how to use Remix for developing and/or debugging Solidity contracts, please see our documentation page