digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-20 09:17:43 +03:00
Code Issues Projects Releases Wiki Activity

Yarn information for the GSG docs (#4920)

Browse Source 
* Solves #4841

* Added info for successfull daml-start.sh script run

* fix syntax

changelog_begin
changelog_end

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
This commit is contained in:
Nemanja 2020-03-13 16:47:12 +01:00 committed by GitHub
parent ff926d0a0f
commit 17f6ec0839
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/getting-started/index.rst
View File

@ -40,7 +40,9 @@ If you haven't already, see :doc:`installation` for the DAML SDK and VSCode deve
You will also need some common software tools to build and interact with the template project.
- `Git <https://git-scm.com/downloads>`_ version control system
- `Yarn <https://yarnpkg.com/getting-started/install>`_ package manager for Javascript
- `Yarn <https://classic.yarnpkg.com/en/docs/install/>`_ package manager for Javascript. You have to have yarn version 1.10.0 or higher.
Note: Ubuntu 17.04 and higher come with ``cmdtest`` package installed by default. If you are getting errors when installing yarn, you may want to run ``sudo apt remove cmdtest`` first and then install yarn. More information can be found `here <https://github.com/yarnpkg/yarn/issues/2821>`_ as well as in the official `yarn installation docs for Debian / Ubuntu <https://classic.yarnpkg.com/en/docs/install/#debian-stable>`_
- A terminal application for command line interaction
@ -58,6 +60,8 @@ Next we need to compile the DAML code to a DAR file::
daml build
Once the DAR file is created you will see this message in terminal ``Created .daml/dist/create-daml-app-0.1.0.dar``.
Any commands starting with ``daml`` are using the :doc:`DAML Assistant </tools/assistant>`, a command line tool in the DAML SDK for building and running DAML apps.
In order to connect the UI code to this DAML, we need to run a code generation step::
@ -78,7 +82,7 @@ In one terminal, at the root of the ``create-daml-app`` directory, run the scrip
./daml-start.sh
This script is just shorthand for ``daml start`` with some arguments, which does a few things:
You will know that script has run successfully when you see the ``INFO com.digitalasset.http.Main$ - Started server: ServerBinding(/0:0:0:0:0:0:0:0:7575)`` message in terminal. The script is just shorthand for ``daml start`` with some arguments, which does a few things:
1. Compiles the DAML code to a DAR file as in the previous ``daml build`` step.
2. Starts an instance of the :doc:`Sandbox </tools/sandbox>`, an in-memory ledger useful for development, loaded with our DAR.