mirror of
https://github.com/digital-asset/daml.git
synced 2024-09-20 09:17:43 +03:00
a0f9eae489
* Respect project name in create-daml-app Now `daml new foobar create-daml-app` creates a project called `foobar` replacing the name everywhere. The tests now run twice once with the original project name since that’s what we use in the GSG and once with a modified one. I guess you could argue that only running the second should be enough so I’m open to removing the first one. fixes #6681 changelog_begin - [DAML Assistant] `daml new foobar create-daml-app` now properly respects the project name and creates a project called `foobar` instead of hardcoding the name fo `create-daml-app`. changelog_end * . changelog_begin changelog_end * Remove debugging output changelog_begin changelog_end |
||
|---|---|---|
| .. | ||
| daml | ||
| ui | ||
| .dlint.yaml | ||
| .gitignore | ||
| daml.yaml.template | ||
| README.md.template | ||
[](https://www.daml.com) [](https://docs.daml.com/getting-started/installation.html) [](https://github.com/digital-asset/daml/blob/master/LICENSE) # Welcome to _Create DAML App_ This repository contains a template to get started with developing full-stack [DAML](https://daml.com/) applications. The demo application covers the following aspects: 1. A [DAML](https://docs.daml.com/index.html) model of a simple social network 2. A UI written in [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/) The UI is developed using [React](https://reactjs.org/), [Semantic UI](https://react.semantic-ui.com/) and its official [React integration](https://react.semantic-ui.com/). The whole project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). Regardless of these choices, all DAML specific aspects of the UI client are written in plain TypeScript and the UI framework should hence be easily replaceable. ## Getting started Before you can run the application, you need to install the [yarn](https://yarnpkg.com/en/docs/install) package manager for JavaScript. There are two steps to build the project. First, we need to generate TypeScript code bindings for the compiled DAML model. At the root of the repository, run ``` daml build daml codegen js .daml/dist/__PROJECT_NAME__-0.1.0.dar -o daml.js ``` The latter command generates TypeScript packages in the `daml.js` directory. Next, navigate to the `ui` directory and install the dependencies and build the app by running ``` cd ui yarn install yarn build ``` The last step is not absolutely necessary but useful to check that the app compiles. To start the application, there are again two steps. In one terminal in the root directory, start a DAML ledger using ``` daml start ``` This must continue running to serve ledger requests. Then in a second terminal window in the `ui` directory, start the UI server via ``` yarn start ``` This should open a browser window with a login screen. If it doesn't, you can manually point your browser to http://localhost:3000. ## A quick tour You can log into the app by providing a user name, say `Alice`. For simplicity of this app, there is no password or sign-up required. You will be greeted by a screen indicating that you're not following anyone and that you don't have any followers yet. You can change this by following someone in the upper box, say `Bob`. After that, let's log out in the top right corner and log in as `Bob`. As `Bob`, we can see that we are not following anyone and that `Alice` is follwing us. We can follow `Alice` by clicking the plus symbol to the right of here name. ## Deploying to DABL Deploying `__PROJECT_NAME__` to the hosted DAML platform [project:DABL](https://projectdabl.com/) is quite simple. Log into your DABL account, create a new ledger and upload your DAML models and your UI. To upload the DAML models, compile them into a DAR by executing ``` daml build -o __PROJECT_NAME__.dar ``` at the root of your repository. Afterwards, open to the DABL website, select the ledger you want to deploy to, go to the "DAML" selection and upload the DAR `__PROJECT_NAME__.dar` you have just created. To upload the UI, create a ZIP file containing all your UI assets by executing ``` daml build daml codegen js .daml/dist/__PROJECT_NAME__-0.1.0.dar -o daml.js (cd ui && yarn build && zip -r ../__PROJECT_NAME__-ui.zip build) ``` at the root of the repository. Afterwards, select the "UI Assets" tab of your chosen ledger on the DABL website, upload the ZIP file (`__PROJECT_NAME__-ui.zip`) you have just created and publish it. To see your deployed instance of `__PROJECT_NAME__` in action, follow the "Visit site" link at the top right corner of your "UI Assets" page. ## Next steps There are many directions in which this application can be extended. Regardless of which direction you pick, the following files will be the most interesting ones to familiarize yourself with: - [`daml/User.daml`](daml/User.daml): the DAML model of the social network - `daml.js/__PROJECT_NAME__-0.1.0/src/User.ts` (once you've generated it): a reflection of the types contained in the DAML model in TypeScript - [`ui/src/components/MainView.tsx`](ui/src/components/MainView.tsx): a React component using the HTTP Ledger API and rendering the main features ## Useful resources TBD ## How to get help TBD