**Remix Project** is a rich toolset including Remix IDE, a comprehensive smart contract development tool. The Remix Project also includes Remix Plugin Engine and Remix Libraries which are low-level tools for wider use.
**Remix Project** is a rich toolset including Remix IDE, a comprehensive smart contract development tool. The Remix Project also includes Remix Plugin Engine and Remix Libraries which are low-level tools for wider use.
## Remix IDE
## Remix IDE
**Remix IDE** is used for the entire journey of contract development by users of any knowledge level. It fosters a fast development cycle and has a rich set of plugins with intuitive GUIs. The IDE comes in 2 flavors and a VSCode extension:
**Remix IDE** is used for the entire journey of contract development by users of any knowledge level. It fosters a fast development cycle and has a rich set of plugins with intuitive GUIs. The IDE comes in 2 flavors and a VSCode extension:
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/using-nx/nx-cli) is installed globally.
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/using-nx/nx-cli) is installed globally.
Run:
Run:
@ -137,7 +137,7 @@ npm --version
nvm --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`.
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
## Unit Testing
@ -149,7 +149,7 @@ For example, to run unit tests of `remix-analyzer`, use `nx test remix-analyzer`
To run the Selenium tests via Nightwatch:
To run the Selenium tests via Nightwatch:
- Install Selenium for first time: `yarn run selenium-install`
- Install Selenium for the first time: `yarn run selenium-install`
- Run a selenium server: `yarn run selenium`
- Run a selenium server: `yarn run selenium`
- Build & Serve Remix: `nx serve`
- Build & Serve Remix: `nx serve`
- Run all the end-to-end tests:
- Run all the end-to-end tests:
@ -165,11 +165,11 @@ To run the Selenium tests via Nightwatch:
**NOTE:**
**NOTE:**
- **The `ballot` tests suite** requires to run `ganache-cli` locally.
- **The `gist` tests suite** requires specifying a github access token in **.env file**.
- **The `gist` tests suite** requires specifying a GitHub access token in **.env file**.
```
```
gist_token = <token> // token should have permission to create a gist
gist_token = <token> // token should have permission to create a gist
```
```
@ -194,9 +194,9 @@ You need to have
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
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.
These groups only apply to the test file, not across all test files. So for example group1 in the ballot is not related to a 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.
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 perform common actions.
There is no need to number the groups in a certain order. The number of the group is arbitrary.
There is no need to number the groups in a certain order. The number of the group is arbitrary.
@ -206,7 +206,7 @@ You should write your tests so they can be executed in groups and not depend on
To do this you need to:
To do this you need to:
- Add a group to tag to a test, they are formatted as #group followed by a number: so it becomes #group1, #group220, #group4. Any number will do. You don't have to do it in specific order.
- Add a group to tag to a test, they are formatted as #group followed by a number: so it becomes #group1, #group220, #group4. Any number will do. You don't have to do it in a specific order.
```
```
'Should generate test file #group1': function (browser: NightwatchBrowser) {
'Should generate test file #group1': function (browser: NightwatchBrowser) {