index.rst

Welcome to Remix's documentation!

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 as well as act as a playground for learning and teaching Ethereum.

Remix IDE is part of the Remix Project which is a platform for development tools that use a plugin architecture. It encompasses sub-projects including Remix Plugin Engine, Remix Libs, and of course Remix-IDE.

Remix IDE is a powerful open source tool that helps you write Solidity contracts straight from the browser.

It is written in JavaScript and supports both usage in the browser, but run locally and in a desktop version.

Remix IDE has modules for testing, debugging and deploying of smart contracts and much more.

Remix-IDE is available at remix.ethereum.org and more information can be found in these docs. Our IDE tool is available at our GitHub repository.

This set of documents covers instructions on how to use Remix. Additional tutorials are found in our Medium blog and in our tutorial tool, LearnEth located inside of Remix IDE.

Useful links:

• Solidity documentation
• Remix alpha - The version where we test new Remix release (not stable!).
• Remix Desktop - Remix Desktop's release page.
• Remix on Github
• Remix on Medium
• Remix on Twitter
• Our Gitter support channel
• Ethereum.org's Developer resources

.. toctree::
   :maxdepth: 2
   :caption: New Layout Intro

   layout

.. toctree::
   :maxdepth: 2
   :caption: Tour of default modules

   file_explorer
   plugin_manager
   settings
   solidity_editor
   terminal

.. toctree::
   :maxdepth: 2
   :caption: Tour of typical solidity modules

   compile
   run
   udapp
   debugger
   static_analysis

.. toctree::
   :maxdepth: 2
   :caption: Solidity Unit Testing

   unittesting
   unittestingAsCLI
   assert_library
   unittesting_examples

.. toctree::
   :maxdepth: 2
   :caption: Native External Integrations

   hardhat
   slither
   hardhat_console

.. toctree::
   :maxdepth: 2
   :caption: Using Remix

   contract_metadata
   create_deploy
   tutorial_debug
   import
   remix_commands
   running_js_scripts
   testing_using_Chai_&_Mocha
   FAS
   remixd
   FAQ

.. toctree::
   :maxdepth: 2
   :caption: Miscellaneous

   locations
   remix_tutorials_learneth
   code_contribution_guide
   community