Skip to main content

Setting up the development environment

In this tutorial, you install the telstion-client-cli and generate a new telestion-client project.


To complete this tutorial, you should be familiar with basic terminal commands.

What you'll build

The result is a project structure that you can begin to customize.

Step 1: Installing tc-cli

Install the tc-cli by running the following command in your terminal:

npm install --global @wuespace/telestion-client-cli

This command installs the CLI, which you can call using the tc-cli command.

Step 2: Initializing the project

This step initializes the project.

Open the terminal where you want to generate the project and run

tc-cli init myproject

Replace myproject with your own desired name.

Using the telestion-project-template

When using the telestion-project-template repository for your project, just run tc-cli init (without a folder name) inside the repo's root folder. This command, then, automatically bootstraps a Client project into the repo's client folder.

This command generates a folder with the chosen name that contains a ready-to-use client project and installs all necessary dependencies.

Windows execution policies

On Windows machines, you might get an error message about execution policies. In this case, run the power shell as administrator and use this command:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

Restart your other terminal and re-run the tc-cli command.

Step 3: Run the client

Run the client by navigating into your folder and run

npm start

This runs tc-cli start --electron in the background.

An electron window opens, and you can see your application.

Next steps

Now that you've generated your client project, you can configure and extend your client in the following tutorials.