Getting Started

1. NPM authentication

To use TALY you need to be logged in to one of the Allianz registries (e.g., https://nexus-frontend.frameworks.allianz.io/). This is necessary to access the TALY SDK and other required packages.

In order to run a TALY command from your working directory, you need to follow one of these approaches:

• Configure the NPM registry globally and authenticate for it following this description.

• Create an .npmrc file in your working directory, pointing to one of the supported NPM registries. Then, log in against that registry. Here is an example of this procedure:

  1. Create an .npmrc: echo registry=https://nexus-frontend.frameworks.allianz.io/repository/npm-public/ > .npmrc
  2. Log in against that registry: npm login --registry=https://nexus-frontend.frameworks.allianz.io/repository/npm-public/

You can find more details about how NPM Authentication works in Allianz in this description, and more general information about the .npmrc file in the official NPM docs.

2. Nx Workspace Setup

Most of the TALY features require an Nx workspace set up in a specific manner. To create a new Nx workspace with the correct dependencies and files, run

npx @allianz/taly-sdk generate-workspace

You can then interactively choose the name of the workspace and its preset. It is possible To create an empty workspace, a workspace with a journey, or a workspace with a Building Block library.

Alternatively, you can provide the name of the workspace and the preset as arguments to the generate-workspace command.

# Empty workspace
npx @allianz/taly-sdk generate-workspace --name "my-taly-workspace" --preset empty

# Workspace with a Journey
npx @allianz/taly-sdk generate-workspace --name "my-taly-workspace" --preset journey

# Workspace with a Building Block library
npx @allianz/taly-sdk generate-workspace --name "my-taly-workspace" --preset library

The workspace-generate command will most likely be everything you need to get started with TALY. For further details on what TALY commands you can use to work with your workspace, see the Quick Start Guides below.

3. Quick Start Guides

The following guides provide a quick overview of the most common tasks when working with TALY.

3.1. Journey Creation

• Create a new Journey project containing a default Journey configuration
• Generate and serve a Journey in watch mode
• Generate the source code of a Journey

3.2. Building Block and Plugin development

• Create a new Building Block library
• Add a new Building Block
• Add a new documentation example to a Building Block
• Add a new plugin