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.
36 lines
2.7 KiB
36 lines
2.7 KiB
7 years ago
|
# Remix
|
||
8 years ago
|
|
||
|
[![Join the chat at https://gitter.im/ethereum/remix](https://badges.gitter.im/ethereum/remix.svg)](https://gitter.im/ethereum/remix?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
6 years ago
|
[![CircleCI](https://circleci.com/gh/ethereum/remix/tree/master.svg?style=svg)](https://circleci.com/gh/ethereum/remix/tree/master)
|
||
5 years ago
|
[![Documentation Status](https://readthedocs.org/projects/docs/badge/?version=latest)](https://remix-ide.readthedocs.io/en/latest/index.html)
|
||
9 years ago
|
|
||
9 years ago
|
|
||
5 years ago
|
**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.
|
||
9 years ago
|
|
||
5 years ago
|
**Remix IDE** is an IDE for Solidity dApp developers, powered by Remix. The Remix IDE repository is available **[here](https://github.com/ethereum/remix-ide)**, and an online version is available at https://remix.ethereum.org.
|
||
9 years ago
|
|
||
5 years ago
|
For more, check out the [Remix IDE documentation](https://remix-ide.readthedocs.io/en/latest/index.html).
|
||
9 years ago
|
|
||
5 years ago
|
## Remix Modules
|
||
9 years ago
|
|
||
5 years ago
|
Remix is built out of several different modules. Here is the brief description.
|
||
9 years ago
|
|
||
5 years ago
|
+ [`remix-analyzer`](remix-analyzer/README.md): Perform static analysis on Solidity smart contracts to check security vulnerabilities and bad development practices
|
||
|
+ [`remix-astwalker`](remix-tests/README.md): Parse solidity AST (Abstract Syntax Tree)
|
||
|
+ [`remix-debug`](remix-debug/README.md): Debug Ethereum transactions. It provides several controls that allow stepping over the trace and seeing the current state of a selected step.
|
||
|
+ [`remix-solidity`](remix-solidity/README.md): Load a Solidity compiler from provided URL and compile the contract using loaded compiler and return the compilation details
|
||
|
+ [`remix-lib`](remix-lib/README.md): Common place for libraries being used across multiple modules
|
||
|
+ [`remix-tests`](remix-tests/README.md): Unit test Solidity smart contracts. It works as a plugin & as CLI both
|
||
|
+ [`remix-url-resolver`](remix-url-resolver/README.md): Provide helpers for resolving the content from external URL ( including github, swarm, ipfs etc.).
|
||
|
+ [`remixd`](https://github.com/ethereum/remixd/tree/master): Allow accessing local filesystem from Remix IDE by running a daemon
|
||
6 years ago
|
|
||
5 years ago
|
Each module generally has their own npm package and test suite, as well as basic documentation in their respective `README`s. Usage of modules as plugin is well documented **[here](https://remix-ide.readthedocs.io/en/latest/index.html)**.
|
||
9 years ago
|
|
||
5 years ago
|
## Contributing
|
||
6 years ago
|
|
||
5 years ago
|
Everyone is very welcome to contribute on the codebase of Remix. Please reach us in [Gitter](https://gitter.im/ethereum/remix) in case of any query/feedback/suggestion.
|
||
7 years ago
|
|
||
5 years ago
|
For more information on the contributing procedure, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
||
7 years ago
|
|
||
|
|