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

Getting started guide: Invoke daml start directly (#5102)

Browse Source 
* Getting started guide: Invoke daml start directly

Since we no can configure arguments we wish to pass to DAML Sandbox
when running `daml start` in `daml.yaml`, we don't need the mysterious
`daml-start.sh` script anymore. That's why
https://github.com/digital-asset/create-daml-app/pull/78
removes the script from `create-daml-app`.

This PR adjust the getting started guide accordingly.

This fixes #4295.

CHANGELOG_BEGIN
CHANGELOG_END

* Fix expected message when daml start successful
This commit is contained in:
Martin Huschenbett 2020-03-20 11:57:23 +01:00 committed by GitHub
parent 6f9b516251
commit 7037f4b6a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/app-dev/app-arch.rst
View File

@ -45,7 +45,7 @@ with a JSON API server by running
.. code-block:: bash
./daml-start.sh
daml start --start-navigator=no
in the root of the project. This is the most simple DAML ledger implementation. Once your
application matures and becomes ready for production, the ``daml deploy`` command helps you deploy

6
docs/source/getting-started/first-feature.rst
View File

@ -21,7 +21,7 @@ There are three parts to building and running the messaging feature:
1. Adding the necessary changes to the DAML model
2. Making the corresponding changes in the UI
3. Running the new feature. In order to do that we need to terminate the previous ``./daml-start.sh`` process and run it again.
3. Running the new feature. In order to do that we need to terminate the previous ``daml start --start-navigator=no`` process and run it again.
As usual, we must start with the DAML model and base our UI changes on top of that.
@ -180,13 +180,13 @@ Let's give the new functionality a spin.
Running the New Feature
=======================
We need to terminate the previous ``./daml-start.sh`` process and run it again, as we need to have a Sandbox instance with a DAR file containing the new feature. As a reminder, by running ``./daml-start.sh`` again we will
We need to terminate the previous ``daml start --start-navigator=no`` process and run it again, as we need to have a Sandbox instance with a DAR file containing the new feature. As a reminder, by running ``daml start --start-navigator=no`` again we will
- Compile our DAML code into a *DAR file containing the new feature*
- Run a fresh instance of the *Sandbox with the new DAR file*
- Start the HTTP JSON API
First, navigate to the terminal window where the ``daml-start.sh`` process is running and terminate the active process by hitting ``Ctrl-C``. This shuts down the previous instances of the sandbox. Next in the root ``create-daml-app`` folder run ``./daml-start.sh``.
First, navigate to the terminal window where the ``daml start --start-navigator=no`` process is running and terminate the active process by hitting ``Ctrl-C``. This shuts down the previous instances of the sandbox. Next in the root ``create-daml-app`` folder run ``daml start --start-navigator=no``.
As mentioned at the beginning of this *Getting Started with DAML* guide, DAML Sandbox uses an in-memory store, which means it loses its state when stopped or restarted. That means that all user data and follower relationships are lost.

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

@ -78,11 +78,11 @@ You should see ``Compiled successfully.`` in the output if everything worked as
We can now run the app in two steps.
You'll need two terminal windows running for this.
In one terminal, at the root of the ``create-daml-app`` directory, run the script::
In one terminal, at the root of the ``create-daml-app`` directory, run the command::
./daml-start.sh
daml start --start-navigator=no
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:
You will know that the command has started successfully when you see the ``INFO com.digitalasset.http.Main$ - Started server: ServerBinding(/127.0.0.1:7575)`` message in the terminal. The command 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.