Setup Guide

Introduction

This guide will help you get started with installation, configuration of the Client and Customer applications, Server, ti-framework SDK, run demo, how to use the applications, customize the application for your unique flow needs.

Prerequisites

• Angular 8+

• NestJS

• TypeScript 3+

• MongoDb

Setup Customer App

Download

Download the repo from here or clone it using the clone command below.

//clone
git clone https://github.com/developerTouchlessInteractive/ticustomer.git

Run

Use the below command to run the app in your choice of browser. We recommend chrome. By default, the app will run in 4200 port and will be launched in your browser (URL: http://localhost:4200/). You can change the port number if 4200 is not available on your localhost. For more options to run the app, please refer to angular CLI documentation here

//run
ng serve -o

//run with port
ng serve --port 4300 --open

Customization

You can extend existing services and components to implement additional functionality. Refer to the integration guide for more information.

Setup Client App

Download

Download the repo from here or clone it using the clone command below.

//clone
git clone https://github.com/developerTouchlessInteractive/ticlient.git

Run

Use the below command to run the app in your choice of browser. We recommend chrome. With the below command, the app will run in 4400 port and will be launched in your browser(URL: http://localhost:4400/). You can change the port number if 4400 is not available on your localhost. For more options to run the app, please refer to angular CLI documentation here

//run with port
ng serve --port 4400 --open

Customization

You can extend existing services and components to implement additional functionality. Refer to integration guide for more information.

Setup Your Server

Download

Repo

Download the repo from here or clone it using the clone command below.

//clone
git clone https://github.com/developerTouchlessInteractive/touchlessInteractive_server.git

Mongo

TI-framework uses MongoDB to store Tasks, Stages, Flows, and Sessions. Please refer to the official documentation on how to install mongo on Mac OS, Windows, or Linux.

Run

Use the below commands to run the Server App.

//run
npm run start

//run in debug
npm run start:dev

By default, the app runs in port:3000. To use a different port, change 3000 in main.ts to a different value.

await app.listen(your_port);

Next Steps

Once all three apps are UP, you are now ready to create Task/Stage/Flow or run a Session. Please refer to Flow Creation and FLOW - orchestration for more information.