daml/templates
Gary Verhaegen f8c0a35940
rewrite trigger docs to follow gsg (#10509)
* rewrite trigger docs to follow gsg

Per #10419 point 4, I've rewritten the Triggers section to build upon
the Getting Started Guide instead of inventing its own example.

Compared to #10395, this has a lot more explanations as this page must
now serve the dual purpose of being a possible "next step" from the GSG
and being the main reference page for triggers. It's also lost the "next
steps" section, which I think is a bit of a shame, but it doesn't really
make sense here.

There's also no easy way for people not interested in the GSG to follow
along; should we expose the "completed GSG" as a tempate?

CHANGELOG_BEGIN
CHANGELOG_END

* keep copy-trigger as a template

* fix copy-trigger project name

* make up gsg-trigger template

* remove awkward sentence, fix existing typo

* update code to use when{,Some}

* add  to

* swap emitCommands and getCommandsInFlight

* typo

* insist on state-correction perspective

* fix copy-trigger tests

* add back copy-trigger to whitelist

* add gsg-trigger to whitelist
2021-08-17 13:28:07 +00:00
..
copy-trigger rewrite trigger docs to follow gsg (#10509) 2021-08-17 13:28:07 +00:00
create-daml-app s/DABL/Daml Hub/ (#10062) 2021-06-21 16:37:17 +02:00
create-daml-app-test-resources Upgrade jest to the latest version (#10107) 2021-06-24 11:16:29 +00:00
empty-skeleton language: add an empty template for the daml assistant. (#6102) 2020-05-26 15:27:10 +02:00
quickstart-java Migrate leftover scenario in quickstart to DAML Script (#7338) 2020-09-08 13:15:45 +02:00
quickstart-scala Migrate leftover scenario in quickstart to DAML Script (#7338) 2020-09-08 13:15:45 +02:00
skeleton Add docs link to skeleton daml.yaml template (#8420) 2021-01-06 20:44:07 +01:00
BUILD.bazel rewrite trigger docs to follow gsg (#10509) 2021-08-17 13:28:07 +00:00
default-dlint.yaml fix template dot-files (#10342) 2021-07-21 11:20:33 +02:00
default-gitattributes Apply new logo to create-daml-app template (#9105) 2021-03-12 13:20:31 +01:00
default-gitignore add gitignores to templates (#2159) 2019-07-16 14:59:08 +01:00
gsg-trigger.patch rewrite trigger docs to follow gsg (#10509) 2021-08-17 13:28:07 +00:00
NO_AUTO_COPYRIGHT fix template dot-files (#10342) 2021-07-21 11:20:33 +02:00
README.txt Daml case and logo (#8433) 2021-01-08 12:50:15 +00:00

These are template projects for `daml new`.

Testing the create-daml-app template
====================================

While automated integration tests for the create-daml-app template are being built,
we have the following manual testing procedure.
Note that this is for testing against the head of the daml repo.
For testing against a released SDK, you can skip past the package.json step and use
`daml` instead of `daml-head` after installing the released version.


First, build the SDK from head using the `daml-sdk-head` command.
This gives an executable Daml assistant called `daml-head` in your path.

Next, instantiate the `create-daml-app` template as follows:

```
daml-head new create-daml-app --template create-daml-app
cd create-daml-app
```

Crucially, you'll need to add a package.json file at the root of the project for testing
(this is not required when using the released SDK).
It should look as follows, with the dummy paths here replaced by relative paths to locally
built TypeScript libraries.
(These need to be built from head using Bazel:
```
bazel build //language-support/ts/daml-types
bazel build //language-support/ts/daml-ledger
bazel build //language-support/ts/daml-react```)

package.json:
{
    "resolutions": {
        "@daml/types": "file:path/to/daml-types/npm_package",
        "@daml/ledger": "file:path/to/daml-ledger/npm_package",
        "@daml/react": "file:path/to/daml-react/npm_package"
    },
    "private": true,
    "workspaces": [
        "daml.js",
        "ui"
    ]
}

Now you can continue to build and run the project as described in create-daml-app/README.md,
using `daml-head` instead of `daml`.
Specifically, you should run the following in the root directory:
```
daml-head build
daml-head codegen js .daml/dist/create-daml-app-0.1.0.dar -o daml.js
daml-head start
```

Then in another terminal, navigate to `create-daml-app/ui/` and run:
```
yarn install
yarn start
```
And check that the app works.

Finally, terminate both the `daml start` and `yarn start` processes and run
`yarn test` from the `ui` directory. All tests should pass.