You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
212 lines
7.1 KiB
212 lines
7.1 KiB
[](https://circleci.com/gh/ethereum/remix-project)
|
|
[](https://remix-ide.readthedocs.io/en/latest/index.html)
|
|
[](https://github.com/ethereum/remix-project/blob/master/CONTRIBUTING.md)
|
|
|
|
[](https://github.com/ethereum/awesome-remix)
|
|
|
|
[](https://gitter.im/ethereum/remix?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](https://twitter.com/ethereumremix)
|
|
|
|
# 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](https://soliditylang.org/)** as well as a playground for learning and teaching [Ethereum](https://ethereum.org/).
|
|
|
|
Start developing using Remix on browser, visit: [https://remix.ethereum.org](https://remix.ethereum.org)
|
|
|
|
For desktop version, see releases: [https://github.com/ethereum/remix-desktop/releases](https://github.com/ethereum/remix-desktop/releases)
|
|
|
|
|
|
|
|
:point_right: **Remix libraries** work as a core of native plugins of Remix IDE. Read more about libraries [here](libs/README.md)
|
|
|
|
## Offline Usage
|
|
|
|
The `master` 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.
|
|
|
|
|
|
## Setup
|
|
|
|
* Install **NPM** and **Node.js**. See [Guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) <br/>
|
|
*Supported versions:*
|
|
```bash
|
|
"engines": {
|
|
"node": "^14.17.6",
|
|
"npm": "^6.14.15"
|
|
}
|
|
```
|
|
* Install [Nx CLI](https://nx.dev/react/cli/overview) globally to enable running **nx executable commands**.
|
|
```bash
|
|
npm install -g @nrwl/cli
|
|
```
|
|
* Clone the github repository (`wget` need to be installed first):
|
|
|
|
```bash
|
|
git clone https://github.com/ethereum/remix-project.git
|
|
```
|
|
* Build `remix-project`:
|
|
```bash
|
|
cd remix-project
|
|
npm install
|
|
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.
|
|
```bash
|
|
npm run build:production
|
|
```
|
|
Build can be found in `remix-project/dist/apps/remix-ide` directory.
|
|
|
|
```bash
|
|
npm run serve:production
|
|
```
|
|
Production build will be served by default to `http://localhost:8080/` or `http://127.0.0.1:8080/`
|
|
|
|
## Docker:
|
|
|
|
Prerequisites:
|
|
* Docker (https://docs.docker.com/desktop/)
|
|
* Docker Compose (https://docs.docker.com/compose/install/)
|
|
|
|
### Run with docker
|
|
|
|
If you want to run latest changes that are merged into master branch then run:
|
|
|
|
```
|
|
docker pull remixproject/remix-ide:latest
|
|
docker run -p 8080:80 remixproject/remix-ide:latest
|
|
```
|
|
|
|
If you want to run latest remix-live release run.
|
|
```
|
|
docker pull remixproject/remix-ide:remix_live
|
|
docker run -p 8080:80 remixproject/remix-ide:remix_live
|
|
```
|
|
|
|
### Run with docker-compose:
|
|
|
|
To run locally without building you only need docker-compose.yaml file and you can run:
|
|
|
|
```
|
|
docker-compose pull
|
|
docker-compose up -d
|
|
```
|
|
|
|
Then go to http://localhost:8080 and you can use you Remix instance.
|
|
|
|
To fetch docker-compose file without cloning this repo run:
|
|
```
|
|
curl https://raw.githubusercontent.com/ethereum/remix-project/master/docker-compose.yaml > docker-compose.yaml
|
|
```
|
|
|
|
### Troubleshooting
|
|
|
|
If you have trouble building the project, make sure that you have the correct version of `node`, `npm` and `nvm`. Also ensure [Nx CLI](https://nx.dev/react/cli/overview) is installed globally.
|
|
|
|
Run:
|
|
|
|
```bash
|
|
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
|
|
|
|
Run the unit tests using library name like: `nx test <project-name>`
|
|
|
|
For example, to run unit tests of `remix-analyzer`, use `nx 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`, or
|
|
|
|
for Google Chrome: `npm run nightwatch_local_chrome`
|
|
- Run a specific test case instead, use one of following commands:
|
|
|
|
- npm run nightwatch_local_ballot
|
|
|
|
- npm run nightwatch_local_usingWorker
|
|
|
|
- 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_specialFunctions
|
|
|
|
- npm run nightwatch_local_solidityUnitTests
|
|
|
|
- npm run nightwatch_local_remixd # remixd needs to be run
|
|
|
|
- npm run nightwatch_local_terminal
|
|
|
|
- npm run nightwatch_local_gist
|
|
|
|
- npm run nightwatch_local_workspace
|
|
|
|
- npm run nightwatch_local_defaultLayout
|
|
|
|
- npm run nightwatch_local_pluginManager
|
|
|
|
- npm run nightwatch_local_publishContract
|
|
|
|
- npm run nightwatch_local_generalSettings
|
|
|
|
- npm run nightwatch_local_fileExplorer
|
|
|
|
- npm run nightwatch_local_debugger
|
|
|
|
- npm run nightwatch_local_editor
|
|
|
|
- npm run nightwatch_local_compiler
|
|
|
|
- npm run nightwatch_local_txListener
|
|
|
|
- npm run nightwatch_local_fileManager
|
|
|
|
- npm run nightwatch_local_runAndDeploy
|
|
|
|
|
|
**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> // token should have permission to create a gist
|
|
```
|
|
|
|
## Important Links
|
|
|
|
- Official documentation: https://remix-ide.readthedocs.io/en/latest/
|
|
- Curated list of Remix resources, tutorials etc.: https://github.com/ethereum/awesome-remix
|
|
- Medium: https://medium.com/remix-ide
|
|
- Twitter: https://twitter.com/ethereumremix
|
|
|