mirror of
https://github.com/digital-asset/daml.git
synced 2024-09-20 01:07:18 +03:00
c1559357f6
The current README dates back to when `create-daml-app` was its own repo, and seems mostly written from the perspective of being the default home page for the project. These days, `create-daml-app` serves two purposes: 1. As the core starting point for the Getting Started Guide, we can assume people who are totally new to Daml will be following the getting started guide. How else would they even know about this template? In that case, I think it's fair to assume the user will *not* be looking to the README for guidance. Therefore, repeating the documentation here seems a bit pointless. 2. As a template to quickstart the creation of a "custom" app that is not the GSG. For that use-case, the README is the place where people would look for information, but at that point the information they're looking for are more along the lines of quick refreshers of what commands to run than explanations on how to use the app as Alice and Bob. CHANGELOG_BEGIN CHANGELOG_END |
||
---|---|---|
.. | ||
copy-trigger | ||
create-daml-app | ||
create-daml-app-test-resources | ||
empty-skeleton | ||
quickstart-java | ||
quickstart-scala | ||
skeleton | ||
BUILD.bazel | ||
default-dlint.yaml | ||
default-gitattributes | ||
default-gitignore | ||
gsg-trigger.patch | ||
NO_AUTO_COPYRIGHT | ||
README.txt |
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.