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

GSG info on restarting the ledger and making changes (#4968)

Browse Source 
* GSG info on restarting the ledger and making changes

CHANGELOG_BEGIN
CHANGELOG_END

* Update docs/source/getting-started/first-feature.rst

Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

* Update docs/source/getting-started/first-feature.rst

Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

* Changed the explanation for why we need to run './daml-start.sh' again

* Update docs/source/getting-started/first-feature.rst

Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

* Update docs/source/getting-started/first-feature.rst

Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

* Update docs/source/getting-started/first-feature.rst

Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

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

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

@ -19,7 +19,12 @@ This means:
We will see that DAML lets us implement these guarantees in a direct and intuitive way.
There are two parts to building the messaging feature: the DAML model and the UI.
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.ch`` process and run it again.
As usual, we must start with the DAML model and base our UI changes on top of that.
DAML Changes
@ -48,8 +53,7 @@ The interesting part is the ``signatory`` clause: both the ``sender`` and ``rece
This enforces the fact that creation and archival of ``Message`` contracts must be authorized by both parties.
Now we can add messaging into the workflow by adding a new choice to the ``User`` template.
Copy the following choice to the ``User`` template after the ``AddFriend`` choice.
(Make sure the indentation matches ``AddFriend``.)
Copy the following choice to the ``User`` template after the ``AddFriend`` choice. The indentation for the ``User`` choice must match the one of ``AddFriend`` . *Make sure you save the file after copying the code*.
.. literalinclude:: code/daml/User.daml
:language: daml
@ -72,7 +76,7 @@ TypeScript Code Generation
Remember that we interface with the DAML model from the UI components using generated TypeScript.
Since we have changed our DAML code, we also need to rerun the TypeScript code generator.
Let's do this by running::
Open a new terminal and run the following commands::
daml build
daml codegen ts .daml/dist/create-daml-app-0.1.0.dar -o daml-ts/src
@ -102,7 +106,7 @@ MessageList Component
The goal of the ``MessageList`` component is to query all ``Message`` contracts where the ``receiver`` is the current user, and display their contents and senders in a list.
The entire component is shown below.
You should copy this into a new ``MessageList.tsx`` file in ``ui/src/components``.
You should copy this into a new ``MessageList.tsx`` file in ``ui/src/components`` and save it.
.. TODO Include file in template with placeholder for component logic.
@ -126,7 +130,7 @@ MessageEdit Component
---------------------
Next we need the ``MessageEdit`` component to compose and send messages to selected friends.
Again we show the entire component here; you should copy this into a new ``MessageEdit.tsx`` file in ``ui/src/components``.
Again we show the entire component here; you should copy this into a new ``MessageEdit.tsx`` file in ``ui/src/components`` and save it.
.. TODO Include file in template with placeholder for component logic.
@ -166,7 +170,7 @@ Open the ``ui/src/components/MainView.tsx`` file and start by adding imports for
:end-before: // IMPORTS_END
Next, find where the *Network* ``Segment`` closes, towards the end of the component.
This is where we'll add a new ``Segment`` for *Messages*.
This is where we'll add a new ``Segment`` for *Messages*. Make sure you've saved the file after copying the code.
.. literalinclude:: code/ui-after/MainView.tsx
:language: tsx
@ -178,24 +182,22 @@ You can see we simply follow the formatting of the previous panels and include t
That is all for the implementation!
Let's give the new functionality a spin.
Running the New App
===================
Running the New Feature
=======================
To start up the new app, open up your terminal application.
First make sure your previously run commands are terminated, in particular the ``daml-start.sh`` command.
You can do this by hitting ``Ctrl-C`` in the terminal window where you ran the command.
This shuts down the previous instances of the sandbox and JSON API server: it is important that we start our new app with new instances of these components.
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
Having done that, first restart the DAML sandbox and JSON API server in the root ``create-daml-app`` folder::
- 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
./daml-start.sh
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``.
Then in another terminal window, change to the ``ui`` folder and restart the application::
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 the friends and their connections are lost.
cd ui
yarn start
If you have the frontend UI up and running you're all set. In case you don't have the UI running open a new terminal window and navigate to the ``create-daml-app/ui`` folder and run the ``yaml start`` command, which will start the UI.
You should see the same login page as before at http://localhost:3000.
Once you've done all these changes you should see the same login page as before at http://localhost:3000.
Once you've logged in, you'll see a familiar UI but with our new *Messages* panel at the bottom!
Go ahead and add some friends, and log in as some of those friends in separate browser windows to add yourself back.
Then, if you click on the dropdown menu in the *Messages* panel, you'll be able to see some friends to message!