Quickstart
==========

Welcome to the Corda Quickstart Guide. Follow the links below to help get going quickly with Corda.

I want to:

* :ref:`Learn <quickstart-learn>` about Corda for the first time
* :ref:`Develop <quickstart-develop>` a CorDapp
* :ref:`Run <quickstart-run>` and test a CorDapp on a local Corda network
* :ref:`Add <quickstart-add>` a node to an existing test Corda network
* :ref:`Add <quickstart-production>` a node to an existing production network

.. _quickstart-learn:

Learn about Corda for the first time
------------------------------------

+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| Useful links                               | Description                                                                                             |
+============================================+=========================================================================================================+
| :doc:`key-concepts`                        | The key concepts and features of the Corda Platform                                                     |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`getting-set-up`                      | Set up your machine for running and developing CorDapps                                                 |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`tutorial-cordapp`                    | A guide to running a simple CorDapp                                                                     |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+

.. _quickstart-develop:

Develop a CorDapp
-----------------

+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| Useful links                               | Description                                                                                             |
+============================================+=========================================================================================================+
| :doc:`hello-world-introduction`            | A coding walk-through of a basic CorDapp                                                                |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`cordapp-overview`                    | An introduction to CordApps                                                                             |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`writing-a-cordapp`                   | How to structure a CorDapp project                                                                      |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`cordapp-build-systems`               | How to build a CorDapp                                                                                  |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`corda-api`                           | A guide to the CorDapp API                                                                              |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+

.. _quickstart-run:

Run and test a CorDapp on local Corda network
---------------------------------------------

+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| Useful links                               | Description                                                                                             |
+============================================+=========================================================================================================+
| :doc:`generating-a-node`                   | Guidance on creating Corda nodes for development and testing locally and on Docker                      |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`node-structure`                      | The Corda node folder structure and how to name your node                                               |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`corda-configuration-file`            | A detailed description of the Corda node configuration file with examples                               |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`running-a-node`                      | Guidance on running Corda nodes locally and on Docker                                                   |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`setting-up-a-corda-network`          | Considerations for setting up a Corda network                                                           |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`shell`                               | Guidance on using an embedded command line to control and monitor a node                                |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`node-administration`                 | How to monitor a Corda node using an RPC interface                                                      |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`node-explorer`                       | A GUI-based tool to view transactional data and transactional history for a node                        |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+

.. _quickstart-add:

Add a node to an existing test Corda network
--------------------------------------------

+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| Useful links                               | Description                                                                                             |
+============================================+=========================================================================================================+
| :doc:`node-structure`                      | The Corda node folder structure and how to name your node                                               |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`corda-configuration-file`            | A detailed description of the Corda node configuration file with examples                               |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`deploying-a-node`                    | A step-by-step guide on deploying a Corda node to your own server                                       |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`azure-vm`                            | A step-by-step guide on creating a Corda Network on Azure                                               |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`aws-vm`                              | A step-by-step guide on creating a Corda Network on AWS                                                 |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`shell`                               | Guidance on using an embedded command line to control and monitor a node                                |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`node-administration`                 | How to monitor a Corda node using an RPC interface                                                      |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`node-explorer`                       | A GUI-based tool to view transactional data and transactional history for a node                        |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :doc:`blob-inspector`                      | A troubleshooting tool allowing you to read the contents of a binary blob file                          |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+

.. _quickstart-production:

Add a node to an existing production network
--------------------------------------------

+---------------------------------------------------------------------------------------------------------+
| Corda Network is a global production network of Corda nodes, operated by the independent                |
| Corda Network Foundation. You can learn more here: https://corda.network/participation/index.html       |
+---------------------------------------------------------------------------------------------------------+
| Corda Testnet is a test network, operated for the community by R3. You can learn                        |
| more here: https://testnet.corda.network                                                                |
+---------------------------------------------------------------------------------------------------------+