Browser-Only Solidity IDE and Runtime Environment Mirror 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.

yann300 4e410a8b7e Merge pull request #2617 from ethereum/gist-e2e-tests 2 hours ago
.circleci 1a0957333d Update config.yml 8 months ago
assets 7b548779d8 Change plugin manager styles 3 months ago
bin f2e772f4b2 standard 11 months ago
ci dae6468dd0 add browser test for testing external web3 3 weeks ago
contracts 1ce1a1f0cf fix importing from node_modules && add more e2e tests 1 month ago
docs 12039f0df2 Merge pull request #2574 from ethereum/docs-udapp-fb-rec 2 weeks ago
embark 3084b15f63 Update package.json 9 months ago
src 4e410a8b7e Merge pull request #2617 from ethereum/gist-e2e-tests 2 hours ago
test 92c355baf0 updated with remix-solidity 1 month ago
test-browser ffa2e74adc Fix failing gist test 1 day ago
.babelrc d6ebbd42d4 refactor browser tests 8 months ago
.env bbcb0fa91c Created and added gist_token variable to .env file for running tests locally 2 weeks ago
.gitignore c88124e3c8 Removing packaga-lock.json from gitignore 7 months ago
.npmignore 7596d48bce fix deploy build folder to npm package 1 year ago
.nvmrc 205ba6476d Create .nvmrc 7 months ago
.travis.yml 52609e2b40 Update .travis.yml 8 months ago
LICENSE.md 7192f8a8a3 Update license year 2019 1 year ago
README.md 9cfd032c11 Removed typo error in README.md 2 weeks ago
_config.yml 002f7d9467 Set theme jekyll-theme-cayman 4 months ago
background.js 2126391e3c Format using standard 3 years ago
best-practices.md 47d88ff11a add a link to coding style guide 1 year ago
icon.png dd7afb5a92 changed the icon for the tab title 5 months ago
index.html 5cc88e476e show app upon css load & add splashscreen 1 week ago
manifest.json 71729bd8da fix loading compiler 1 year ago
meetings.md c5994bd93b Create meetings.md 8 months ago
nightwatch.js 003c2f28a2 remove old files & update README 8 months ago
nightwatch_debugger.js 0aa2ac8296 updatea IE version for tesing 1 year ago
package-lock.json dc62bc9f36 Merge pull request #2583 from ethereum/refactor_logic6_2 2 weeks ago
package.json ffa2e74adc Fix failing gist test 1 day ago
release-process.md 71fd512457 Update release-process.md 2 months ago
remix_screenshot.png 1f795bdc60 Add files via upload 8 months ago
research-project.md d9203e76f8 Create research-project.md 1 year ago
team-best-practices.md 37b027de19 Fix documentation links to remix-ide site 6 months ago

README.md

CircleCI

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  # only if you plan to link remix and remix-ide repositories and develop on it.
npm install  # only if you plan to link remix and remix-ide repositories and develop on it.
npm run bootstrap  # 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:

  • Build Remix IDE and serve it: npm run build && npm run serve # starts web server at localhost:8080
  • Make sure Selenium is installed npm run selenium-install # don't need to repeat
  • Run a selenium server npm run selenium
  • Run all the tests npm run nightwatch_local_firefox or npm run nightwatch_local_chrome
  • Or run a specific test case:

    - npm run nightwatch_local_ballot
    
    - npm run nightwatch_local_libraryDeployment
    
    - npm run nightwatch_local_solidityImport
    
    - npm run nightwatch_local_recorder
    
    - npm run nightwatch_local_transactionExecution
    
    - npm run nightwatch_local_staticAnalysis
    
    - npm run nightwatch_local_signingMessage
    
    - npm run nightwatch_local_console
    
    - npm run nightwatch_local_remixd # remixd needs to be run
    

    NOTE:

  • the ballot tests suite requires to run ganache-cli locally.

  • the remixd tests suite requires to run remixd locally.

  • the gist tests suite requires specifying a github access token in .env file.

    gist_token = <token>
    

    note that this token should have permission to create a gist.

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