Skip to content

livechat/livechat-public-docs

Repository files navigation

Platform Docs

Netlify Status

Hello 👋!

This is the repository for the Platform documentation. Our documents are written in the MDX format, so pay attention to our custom tags when contributing to the docs.

Who we are

Behind Text, Inc. there is a team of passionate people building online customer service software with online chat, help desk software, chatbot, and web analytics capabilities.

With a suite of five products (LiveChat, ChatBot, HelpDesk, KnowledgeBase, and OpenWidget) and their powerful APIs, we power customer communication for 37,000 companies in 150 countries.

The Platform is a range of products and services that can be used to build a variety of communication tools for businesses. Our Developer Program and Marketplace create an open ecosystem for developers, partners, and customers.

Node version

We require node version 14.x.

Development

  1. Fetch the repository
  2. Run npm install
  3. Run npm run dev
  4. Open http://localhost:3000/docs

Production

We are using Netlify to serve the docs in production.

You can simulate the production build process locally by running.

  1. Run npm run build
  2. Run npm start

Feature branch / Deploy preview

In order to test your work before merging to master, Netlify provides Deploy Preview. When raising a PR, GitHub will provide Netlify notifications with the Deploy Preview url that can be found in the checks section.

How to contribute

All contribution's welcome! Read how to do it.

Get in touch