mirror of
https://github.com/corda/corda.git
synced 2024-12-28 08:48:57 +00:00
169 lines
9.1 KiB
ReStructuredText
169 lines
9.1 KiB
ReStructuredText
Getting set up
|
|
==============
|
|
|
|
Software requirements
|
|
---------------------
|
|
Corda uses industry-standard tools:
|
|
|
|
* **Oracle JDK 8 JVM** - supported version **8u131**
|
|
* **IntelliJ IDEA** - supported versions **2017.1**, **2017.2** and **2017.3**
|
|
* **Gradle** - supported version **3.4**
|
|
* **Kotlin** - supported version **1.1.2**
|
|
* **Git**
|
|
|
|
You do not need to install Gradle or Kotlin. A standalone Gradle wrapper is provided, and it will download the correct
|
|
version of Kotlin.
|
|
|
|
Please note:
|
|
|
|
* Corda runs in a JVM. JVM implementations other than Oracle JDK 8 are not actively supported. However, if you do
|
|
choose to use OpenJDK, you will also need to install OpenJFX
|
|
|
|
* Applications on Corda (CorDapps) can be written in any language targeting the JVM. However, Corda itself and most of
|
|
the samples are written in Kotlin. Kotlin is an
|
|
`official Android language <https://developer.android.com/kotlin/index.html>`_, and you can read more about why
|
|
Kotlin is a strong successor to Java
|
|
`here <https://medium.com/@octskyward/why-kotlin-is-my-next-programming-language-c25c001e26e3>`_. If you're
|
|
unfamiliar with Kotlin, there is an official
|
|
`getting started guide <https://kotlinlang.org/docs/tutorials/>`_, and a series of
|
|
`Kotlin Koans <https://kotlinlang.org/docs/tutorials/koans.html>`_.
|
|
|
|
* IntelliJ IDEA is recommended due to the strength of its Kotlin integration.
|
|
|
|
Following these software recommendations will minimize the number of errors you encounter, and make it easier for
|
|
others to provide support. However, if you do use other tools, we'd be interested to hear about any issues that arise.
|
|
|
|
Set-up instructions
|
|
-------------------
|
|
The instructions below will allow you to set up a Corda development environment and run a basic CorDapp on a Windows
|
|
or Mac machine. If you have any issues, please consult the :doc:`troubleshooting` page, or reach out on
|
|
`Slack <http://slack.corda.net/>`_ or the `forums <https://discourse.corda.net/>`_.
|
|
|
|
.. note:: The set-up instructions are also available in video form for both `Windows <https://vimeo.com/217462250>`_ and `Mac <https://vimeo.com/217462230>`_.
|
|
|
|
Windows
|
|
^^^^^^^
|
|
|
|
Java
|
|
~~~~
|
|
1. Visit http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
|
|
2. Scroll down to "Java SE Development Kit 8uXXX" (where "XXX" is the latest minor version number)
|
|
3. Toggle "Accept License Agreement"
|
|
4. Click the download link for jdk-8uXXX-windows-x64.exe (where "XXX" is the latest minor version number)
|
|
5. Download and run the executable to install Java (use the default settings)
|
|
6. Open a new command prompt and run ``java -version`` to test that Java is installed correctly
|
|
|
|
Git
|
|
~~~
|
|
1. Visit https://git-scm.com/download/win
|
|
2. Click the "64-bit Git for Windows Setup" download link.
|
|
3. Download and run the executable to install Git (use the default settings)
|
|
4. Open a new command prompt and type ``git --version`` to test that git is installed correctly
|
|
|
|
IntelliJ
|
|
~~~~~~~~
|
|
1. Visit https://www.jetbrains.com/idea/download/download-thanks.html?code=IIC
|
|
2. Download and run the executable to install IntelliJ Community Edition (use the default settings)
|
|
|
|
Download a sample project
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
1. Open a command prompt
|
|
2. Clone the CorDapp tutorial repo by running ``git clone https://github.com/corda/cordapp-tutorial``
|
|
3. Move into the cordapp-tutorial folder by running ``cd cordapp-tutorial``
|
|
4. Retrieve a list of all the milestone (i.e. stable) releases by running ``git branch -a --list *release-M*``
|
|
5. Check out the latest milestone release by running ``git checkout release-MX`` (where "X" is the latest milestone)
|
|
|
|
Run from the command prompt
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
1. From the cordapp-tutorial folder, deploy the nodes by running ``gradlew deployNodes``
|
|
2. Start the nodes by running ``call kotlin-source/build/nodes/runnodes.bat``
|
|
3. Wait until all the terminal windows display either "Webserver started up in XX.X sec" or "Node for "NodeC" started up and registered in XX.XX sec"
|
|
4. Test the CorDapp is running correctly by visiting the front end at http://localhost:10007/web/example/
|
|
|
|
Run from IntelliJ
|
|
~~~~~~~~~~~~~~~~~
|
|
1. Open IntelliJ Community Edition
|
|
2. On the splash screen, click "Open" (do NOT click "Import Project") and select the cordapp-template folder
|
|
|
|
.. warning:: If you click "Import Project" instead of "Open", the project's run configurations will be erased!
|
|
|
|
3. Once the project is open, click "File > Project Structure". Under "Project SDK:", set the project SDK by clicking "New...", clicking "JDK", and navigating to C:\Program Files\Java\jdk1.8.0_XXX (where "XXX" is the latest minor version number). Click "OK".
|
|
4. Click "View > Tool Windows > Event Log", and click "Import Gradle project", then "OK". Wait, and click "OK" again when the "Gradle Project Data To Import" window appears
|
|
5. Wait for indexing to finish (a progress bar will display at the bottom-right of the IntelliJ window until indexing is complete)
|
|
6. At the top-right of the screen, to the left of the green "play" arrow, you should see a dropdown. In that dropdown, select "Run Example Cordapp - Kotlin" and click the green "play" arrow.
|
|
7. Wait until the run windows displays the message "Webserver started up in XX.X sec"
|
|
8. Test the CorDapp is running correctly by visiting the front end at http://localhost:10007/web/example/
|
|
|
|
Mac
|
|
^^^
|
|
|
|
Java
|
|
~~~~
|
|
1. Open "System Preferences > Java"
|
|
2. In the Java Control Panel, if an update is available, click "Update Now"
|
|
3. In the "Software Update" window, click "Install Update". If required, enter your password and click "Install Helper" when prompted
|
|
4. Wait for a pop-up window indicating that you have successfully installed the update, and click "Close"
|
|
5. Open a new terminal and type ``java -version`` to test that Java is installed correctly
|
|
|
|
IntelliJ
|
|
~~~~~~~~
|
|
1. Visit https://www.jetbrains.com/idea/download/download-thanks.html?platform=mac&code=IIC
|
|
2. Download and run the executable to install IntelliJ Community Edition (use the default settings)
|
|
|
|
Download a sample project
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
1. Open a terminal
|
|
2. Clone the CorDapp tutorial repo by running ``git clone https://github.com/corda/cordapp-tutorial``
|
|
3. Move into the cordapp-tutorial folder by running ``cd cordapp-tutorial``
|
|
4. Retrieve a list of all the milestone (i.e. stable) releases by running ``git branch -a --list *release-M*``
|
|
5. Check out the latest milestone release by running ``git checkout release-MX`` (where "X" is the latest milestone)
|
|
|
|
Run from the terminal
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
1. From the cordapp-tutorial folder, deploy the nodes by running ``./gradlew deployNodes``
|
|
2. Start the nodes by running ``kotlin-source/build/nodes/runnodes``. Do not click while 8 additional terminal windows start up.
|
|
3. Wait until all the terminal windows display either "Webserver started up in XX.X sec" or "Node for "NodeC" started up and registered in XX.XX sec"
|
|
4. Test the CorDapp is running correctly by visiting the front end at http://localhost:10007/web/example/
|
|
|
|
Run from IntelliJ
|
|
~~~~~~~~~~~~~~~~~
|
|
1. Open IntelliJ Community Edition
|
|
2. On the splash screen, click "Open" (do NOT click "Import Project") and select the cordapp-template folder
|
|
3. Once the project is open, click "File > Project Structure". Under "Project SDK:", set the project SDK by clicking "New...", clicking "JDK", and navigating to /Library/Java/JavaVirtualMachines/jdk1.8.0_XXX (where "XXX" is the latest minor version number). Click "OK".
|
|
4. Click "View > Tool Windows > Event Log", and click "Import Gradle project", then "OK". Wait, and click "OK" again when the "Gradle Project Data To Import" window appears
|
|
5. Wait for indexing to finish (a progress bar will display at the bottom-right of the IntelliJ window until indexing is complete)
|
|
6. At the top-right of the screen, to the left of the green "play" arrow, you should see a dropdown. In that dropdown, select "Run Example Cordapp - Kotlin" and click the green "play" arrow.
|
|
7. Wait until the run windows displays the message "Webserver started up in XX.X sec"
|
|
8. Test the CorDapp is running correctly by visiting the front end at http://localhost:10007/web/example/
|
|
|
|
Corda source code
|
|
-----------------
|
|
|
|
The Corda platform source code is available here:
|
|
|
|
https://github.com/corda/corda.git
|
|
|
|
A CorDapp template that you can use as the basis for your own CorDapps is available here:
|
|
|
|
https://github.com/corda/cordapp-template.git
|
|
|
|
And a simple example CorDapp for you to explore basic concepts is available here:
|
|
|
|
https://github.com/corda/cordapp-tutorial.git
|
|
|
|
You can clone these repos to your local machine by running the command ``git clone [repo URL]``.
|
|
|
|
By default, these repos will be on the unstable ``master`` branch. You should check out the latest milestone release
|
|
instead by running ``git checkout release-M13``.
|
|
|
|
Next steps
|
|
----------
|
|
|
|
The best way to check that everything is working fine is by :doc:`running-the-demos`.
|
|
|
|
Once you have these demos running, you may be interested in writing your own CorDapps, in which case you should refer to
|
|
:doc:`tutorial-cordapp`.
|
|
|
|
If you encounter any issues, please see the :doc:`troubleshooting` page, or get in touch with us on the
|
|
`forums <https://discourse.corda.net/>`_ or via `slack <http://slack.corda.net/>`_.
|