2016-11-17 18:31:17 +00:00
Welcome to the Corda documentation!
===================================
2015-11-25 13:27:07 +00:00
2016-12-06 10:12:57 +00:00
.. warning :: This build of the docs is from the "|version|" branch, not a milestone release. It may not reflect the
2017-02-22 10:52:47 +00:00
current state of the code. `Read the docs for milestone release M8.2 <https://docs.corda.net/releases/release-M8.2/> `_ .
2016-08-30 10:53:34 +00:00
2017-02-06 16:52:15 +00:00
`Corda <https://www.corda.net/> `_ is an open-source distributed ledger platform. The latest *milestone* (i.e. stable)
2017-02-22 10:52:47 +00:00
release is M8.2. The codebase is on `GitHub <https://github.com/corda> `_ , and our community can be found on
2017-01-10 10:18:38 +00:00
`Slack <https://slack.corda.net/> `_ and in our `forum <https://discourse.corda.net/> `_ .
2016-08-11 12:57:41 +00:00
2017-02-06 16:52:15 +00:00
If you're new to Corda, you should start by learning about its motivating vision and architecture. A good introduction
is the `Introduction to Corda webinar <https://vimeo.com/192757743/c2ec39c1e1> `_ and the `Introductory white paper`_ . As
they become more familiar with Corda, readers with a technical background will also want to dive into the `Technical white paper`_ ,
2017-01-10 10:18:38 +00:00
which describes the platform's envisioned end-state.
2017-02-06 16:52:15 +00:00
Corda is designed so that developers can easily extend its functionality by writing CorDapps
(**Cor** \ da **D** \ istributed **App** \ lication\ **s** \ ). Some example CorDapps are available in the Corda repo's
`samples <https://github.com/corda/corda/tree/master/samples> `_ directory. To run these yourself, make
sure you follow the instructions in :doc: `getting-set-up` , then go to
2017-01-31 12:59:24 +00:00
:doc: `running-the-demos` .
2017-02-08 10:34:54 +00:00
If, after running the demos, you're interested in writing your own CorDapps, you can use the
`CorDapp template <https://github.com/corda/cordapp-template> `_ as a base. A simple example CorDapp built upon the template is available `here <https://github.com/corda/cordapp-tutorial> `_ , and a video primer on basic CorDapp structure is available `here <https://vimeo.com/192797322/aab499b152> `_ .
2017-01-10 10:18:38 +00:00
2017-02-06 16:52:15 +00:00
From there, you'll be in a position to start extending the example CorDapp yourself (e.g. by writing new states, contracts,
and/or flows). For this, you'll want to refer to this docsite, and to the `tutorials <https://docs.corda.net/tutorial-contract.html> `_
2017-01-10 10:18:38 +00:00
in particular. If you get stuck, get in touch on `Slack <https://slack.corda.net/> `_ or the `forum <https://discourse.corda.net/> `_ .
2017-02-06 16:52:15 +00:00
Once you're familiar with Corda and CorDapp development, we'd encourage you to get involved in the development of the
2017-01-10 10:18:38 +00:00
platform itself. Find out more about `contributing to Corda <https://github.com/corda/corda/wiki/Corda's-Open-Source-Approach> `_ .
2015-11-25 13:27:07 +00:00
2016-11-04 13:10:27 +00:00
.. _`Introductory white paper`: _static/corda-introductory-whitepaper.pdf
.. _`Technical white paper`: _static/corda-technical-whitepaper.pdf
2016-03-08 17:32:13 +00:00
2017-01-10 10:18:38 +00:00
Documentation Contents:
=======================
2015-11-25 13:27:07 +00:00
.. toctree ::
:maxdepth: 2
2016-11-18 12:17:32 +00:00
:caption: Getting started
2015-11-25 13:27:07 +00:00
inthebox
getting-set-up
2016-11-29 18:31:28 +00:00
getting-set-up-fault-finding
2016-11-18 12:17:32 +00:00
running-the-demos
2016-11-28 11:44:03 +00:00
CLI-vs-IDE
2016-11-18 12:17:32 +00:00
.. toctree ::
:maxdepth: 2
:caption: Key concepts
2017-01-26 15:46:40 +00:00
key-concepts
key-concepts-ecosystem
key-concepts-data-model
key-concepts-core-types
key-concepts-financial-model
key-concepts-flow-framework
key-concepts-consensus-notaries
key-concepts-vault
key-concepts-security-model
2016-11-29 18:31:28 +00:00
.. toctree ::
:maxdepth: 2
:caption: CorDapps
creating-a-cordapp
tutorial-cordapp
2016-11-18 12:17:32 +00:00
.. toctree ::
:maxdepth: 2
:caption: The Corda node
clientrpc
2015-12-14 17:22:21 +00:00
messaging
2016-09-27 14:17:27 +00:00
persistence
2016-03-04 15:15:32 +00:00
node-administration
2016-11-25 14:29:13 +00:00
corda-configuration-file
2016-11-22 11:57:11 +00:00
corda-plugins
2016-11-21 18:14:18 +00:00
node-services
2016-11-24 16:38:40 +00:00
node-explorer
permissioning
2016-07-28 10:46:12 +00:00
2015-12-22 15:15:38 +00:00
.. toctree ::
:maxdepth: 2
:caption: Tutorials
2016-05-17 17:40:53 +00:00
tutorial-contract
2016-07-12 09:24:11 +00:00
tutorial-contract-clauses
2016-07-08 17:33:48 +00:00
tutorial-test-dsl
2017-02-13 15:39:48 +00:00
contract-upgrade
2016-11-25 15:26:00 +00:00
tutorial-integration-testing
2016-10-04 12:56:31 +00:00
tutorial-clientrpc-api
2016-11-28 13:39:34 +00:00
tutorial-building-transactions
2016-11-24 08:21:21 +00:00
flow-state-machines
2016-11-21 17:11:51 +00:00
flow-testing
2016-11-25 15:11:19 +00:00
running-a-notary
using-a-notary
2016-03-11 12:42:11 +00:00
oracles
2016-09-23 13:41:29 +00:00
tutorial-attachments
2016-05-24 09:03:29 +00:00
event-scheduling
2015-12-22 15:15:38 +00:00
2016-08-26 13:31:17 +00:00
.. toctree ::
:maxdepth: 2
2016-11-18 12:17:32 +00:00
:caption: Other
2016-08-26 13:31:17 +00:00
2016-11-18 12:17:32 +00:00
network-simulator
2017-01-26 15:46:40 +00:00
clauses
merkle-trees
2016-08-26 13:31:17 +00:00
.. toctree ::
:maxdepth: 2
2016-11-18 12:17:32 +00:00
:caption: Component library
2016-08-26 13:31:17 +00:00
2016-11-18 12:17:32 +00:00
contract-catalogue
contract-irs
2016-08-26 13:31:17 +00:00
2015-12-22 15:15:38 +00:00
.. toctree ::
:maxdepth: 2
:caption: Appendix
2016-11-18 12:16:06 +00:00
loadtesting
2016-11-28 11:58:14 +00:00
setting-up-a-corda-network
2016-10-12 10:54:23 +00:00
secure-coding-guidelines
2016-05-10 16:44:41 +00:00
release-process
2016-05-24 11:26:17 +00:00
release-notes
2016-01-27 15:01:33 +00:00
codestyle
2016-04-27 17:37:27 +00:00
building-the-docs
2017-01-26 15:46:40 +00:00
further-notes-on-kotlin
2016-12-08 12:14:17 +00:00
publishing-corda
2016-12-21 09:57:37 +00:00
azure-vm
2016-11-18 12:17:32 +00:00
.. toctree ::
:maxdepth: 2
:caption: Glossary
2016-11-21 16:00:22 +00:00
glossary