Remix is a browser-based compiler and IDE that enables users to build Ethereum contracts with Solidity language and to debug transactions.
Remix is a browser-based compiler and IDE that enables users to build Ethereum contracts with Solidity language and to debug transactions.
ethereum/remix-project
Remix Project
Remix Project is a platform for development tools that use a plugin architecture. It encompasses sub-projects including Remix Plugin Engine, Remix Libraries, and of course Remix IDE.
Remix IDE is an open source web and desktop application. It fosters a fast development cycle and has a rich set of plugins with intuitive GUIs. Remix is used for the entire journey of contract development with Solidity language as well as a playground for learning and teaching Ethereum.
Start developing using Remix on browser, visit: https://remix.ethereum.org
For desktop version, see releases: https://github.com/ethereum/remix-desktop/releases
Offline Usage
The
gh-pages
branch of remix-live always has the latest stable build of Remix. It contains a ZIP file with the entire build. Download it to use offline.Note: It contains the latest supported version of Solidity available at the time of the packaging. Other compiler versions can be used online only.
Setup
Supported versions:
wget
need to be installed first):remix-project
:cd remix-project npm install npm run build:libs // Build remix libs nx build nx serve
Open
http://127.0.0.1:8080
in your browser to load Remix IDE locally.Go to your
text editor
and start developing. Browser will automatically refresh when files are saved.Production Build
To generate react production builds for remix-project.
Build can be found in
remix-project/dist/apps/remix-ide
directory.Production build will be served by default to
http://localhost:8080/
orhttp://127.0.0.1:8080/
Docker:
Prerequisites:
Run with docker
If you want to run latest changes that are merged into master branch then run:
If you want to run latest remix-live release run.
Run with docker-compose:
To run locally without building you only need docker-compose.yaml file and you can run:
Then go to http://localhost:8080 and you can use you Remix instance.
To fetch docker-compose file without cloning this repo run:
Troubleshooting
If you have trouble building the project, make sure that you have the correct version of
node
,npm
andnvm
. Also ensure Nx CLI is installed globally.Run:
In Debian based OS such as Ubuntu 14.04LTS you may need to run
apt-get install build-essential
. After installingbuild-essential
, runnpm rebuild
.Unit Testing
Run the unit tests using library name like:
nx test <project-name>
For example, to run unit tests of
remix-analyzer
, usenx test remix-analyzer
Browser Testing
To run the Selenium tests via Nightwatch:
Install Selenium for first time:
npm run selenium-install
Run a selenium server:
npm run selenium
Build & Serve Remix:
nx serve
Run all the end-to-end tests:
for Firefox:
npm run nightwatch_local_firefox
, orfor Google Chrome:
npm run nightwatch_local_chrome
Run a specific test case instead, use a command like this:
The package.json file contains a list of all the tests you can run.
NOTE:
The
ballot
tests suite requires to runganache-cli
locally.The
remixd
tests suite requires to runremixd
locally.The
gist
tests suite requires specifying a github access token in .env file.Using 'select_test' for locally running specific tests
There is a script to allow selecting the browser and a specific test to run:
You need to have
selenium running
the IDE running
optionally have remixd or ganache running
Splitting tests with groups
Groups can be used to group tests in a test file together. The advantage is you can avoid running long test files when you want to focus on a specific set of tests within a test file.x
These groups only apply to the test file, not across all test files. So for example group1 in the ballot is not related to group1 in another test file.
Running a group only runs the tests marked as belonging to the group + all the tests in the test file that do not have a group tag. This way you can have tests that run for all groups, for example to peform common actions.
There is no need to number the groups in a certain order. The number of the group is arbitrary.
A test can have multiple group tags, this means that this test will run in different groups.
You should write your tests so they can be executed in groups and not depend on other groups.
To do this you need to:
Locally testing group tests
You can tag any test with a groupname, for example, #group10 and easily run the test locally.
method 1
This script will give you an option menu, just select the test you want
method 2
Run the same (flaky) test across all instances in CircleCI
In CircleCI all tests are divided across instances to run in paralel. You can also run 1 or more tests simultaneously across all instances. This way the pipeline can easily be restarted to check if a test is flaky.
For example:
Now group3 of this test will be executed in firefox and chrome 80 times. If you mark more groups in other tests they will also be executed.
CONFIGURATION
It's important to set a parameter in the .circleci/config.yml, set it to false then the normal tests will run. Set it to true to run only tests marked with flaky.
Important Links