This repository is archived and no longer maintained. Instead take a look at: https://github.com/livechat/developer-studio.
This project unlocks LiveChat Developer Console capabilities in form of easy to use CLI application. Additionally it allows for quick application bootstrap and project scaffolding.
Use the npm or yarn package managers to install the dev-cli package in your project.
npm install -g @livechat/dev-cli
# or
yarn global add @livechat/dev-cliLiveChat Developer Console CLI
lcdev [command]
Commands:
lcdev init [dirName] scafold new LiveChat app project from template
lcdev login login with your LiveChat account
lcdev bootstrap bootstrap new LiveChat app using config file
lcdev create create new LiveChat app
lcdev widget setup agent app widget
lcdev auth setup app authorization
lcdev app-webhooks setup app webhooks
lcdev chat-webhooks setup chat webhooks
lcdev chat-actions setup chat actions
lcdev chat-boosters setup chat boosters
lcdev remove remove app
Options:
--help Show help
--version Show version number
Below you'll find a step by step guide how to go from a brand new LiveChat Developer Program account to a fully working LiveChat application ready to be used on your LiveChat account.
Warning Before you start make sure to already have a LiveChat account (you can create one here). You will also need Ngrok together with its free account installed on your computer to obtain a temporary and secure public domain for your local application (follow these instructions).
- Install the
LiveChat Developer Console CLI:
npm install -g @livechat/dev-cli- Verify that you are using the latest version and can access the CLI:
lcdev --version- Login to your LiveChat account inside the CLI:
lcdev login- Initialize a new project from our official Nex.js app template:
lcdev init first-livechat-app- Install project dependencies and start local dev server:
cd first-livechat-app
npm install
npm run dev- Open the HTTP tunnel to obtain secure public domain for your local app:
ngrok http 3000- Bootstrap your new LiveChat app by providing the newly established public domain:
lcdev bootstrap --baseURL <your-https-domain-from-ngrok>Read the Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.
This project has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
The code and documentation in this project are released under the MIT License.