remix-project mirror
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.
 
 
 
 
 
dependabot[bot] ba17eebe5e Bump acorn from 6.3.0 to 6.4.1 in /remix-url-resolver 5 years ago
.circleci Add remix-astwalker commits to a new branch 6 years ago
docs remove everything but link to new location of docs 6 years ago
docs_old documentaion: convert rst to md 7 years ago
remix-analyzer changelog updated 5 years ago
remix-astwalker bump lib versions 5 years ago
remix-debug bump lib versions 5 years ago
remix-debugger use new solc version. Update the interface 5 years ago
remix-lib bump lib versions 5 years ago
remix-simulator bump lib versions 5 years ago
remix-solidity bump lib versions 5 years ago
remix-tests bump lib versions 5 years ago
remix-url-resolver Bump acorn from 6.3.0 to 6.4.1 in /remix-url-resolver 5 years ago
remixd@1a9ec3230e addRemixd 6 years ago
.gitignore Adding package-lock.json files to all the subprojects 5 years ago
.gitmodules addRemixd 6 years ago
.npmignore Add travis config. 9 years ago
CHANGELOG.md changelog updated 5 years ago
CONTRIBUTING.md contribution file updated 5 years ago
LICENSE docs: Add Contributors to license 6 years ago
README.md suggested changes 5 years ago
gulpfile.js suggested changes 5 years ago
lerna.json lerna mistake 6 years ago
package-lock.json update package lock 5 years ago
package.json bump root version 5 years ago
release-process.md changelog auto update 5 years ago
tasks.todo string with comma handled 5 years ago

README.md

Remix

Join the chat at https://gitter.im/ethereum/remix CircleCI Documentation Status

Remix is a suite of tools that helps smart contract development, compilation, testing & deployment. These tools also works as a core of native plugins of Remix IDE.

Remix IDE is an IDE for Solidity dApp developers, powered by Remix. The Remix IDE repository is available here, and an online version is available at https://remix.ethereum.org.

For more, check out the Remix IDE documentation.

Remix Modules

Remix is built out of several different modules. Here is the brief description.

  • remix-analyzer: Perform static analysis on Solidity smart contracts to check security vulnerabilities and bad development practices
  • remix-astwalker: Parse solidity AST (Abstract Syntax Tree)
  • remix-debug: Debug Ethereum transactions. It provides several controls that allow stepping over the trace and seeing the current state of a selected step.
  • remix-solidity: Load a Solidity compiler from provided URL and compile the contract using loaded compiler and return the compilation details
  • remix-lib: Common place for libraries being used across multiple modules
  • remix-tests: Unit test Solidity smart contracts. It works as a plugin & as CLI both
  • remix-url-resolver: Provide helpers for resolving the content from external URL ( including github, swarm, ipfs etc.).
  • remixd: Allow accessing local filesystem from Remix IDE by running a daemon

Each module generally has their own npm package and test suite, as well as basic documentation in their respective READMEs. Usage of modules as plugin is well documented here.

Contributing

Everyone is very welcome to contribute on the codebase of Remix. Please reach us in Gitter in case of any query/feedback/suggestion.

For more information on the contributing procedure, see CONTRIBUTING.md.