Creating a New Plantt App

This guide will walk you through how to create your first conversational app using Plantt.

A Plantt App is the top-level entity for Plantt. It contains all the conversation flows and logic of your product. Once you have created your app, you can deploy an app to multiple channels such as Whatsapp, Messenger - or you can use our SDK to create your own custom UI.

Using the Plantt CLI

Step 1: Get the Plantt CLI

First, run the following command in a terminal window to download & install the Plantt CLI tools.

npm install -g plantt

The Plantt CLI is our UI, and your way to manage your Plantt assets. With this tool you'll be able to see and manage flows, and deploy code and functions of your own (yay!)

Step 2: Authenticate

In your terminal, run the following command:

plantt login

You will be asked to enter your username & password for your Plantt account. Enter the username and password you have registered with. Make sure you get the Login Successful message.

Step 3: Create a new App

To create a new app, run the following command:

plantt init my-app

Replace my-app with a descriptive identifier to your app.

Running the above command will create a directory called my-app inside the current folder. Inside that directory, it will generate the initial project structure, ready to deploy and test:

..

Once the installation is done, you can open your project folder. No complicated structure there, let's go through this briefly:

  • flows is where you define the conversation flows of your app.

  • functionsis where your custom code and business logic goes.

  • deployments holds the configurations files for your app specific channels (e.g Whatsapp / Messenger)

  • plantt.yaml are some unique configurations of your app.