Skip to content

Latest commit

 

History

History
executable file
·
60 lines (40 loc) · 3.88 KB

README.md

File metadata and controls

executable file
·
60 lines (40 loc) · 3.88 KB
Raw

Project Ana - Open Source Conversation Suite

License: GPL v3 Build Status Build status Codacy Badge

World's first Open Source Conversation Platform which comes with a Graphical Chat Flow Designer and Chat Simulator. Supported channels are Web Chat, Android, iOS and Facebook Messenger.

The Ana app

A single cross-platform app where you can design and publish Ana chatbots, manage users and check the chatbot analytics.

Installation

Download The Ana app from https://www.ana.chat/downloads.html

How to use Ana app?

The goal of The Ana app is to make it easier to build chat flows without much technical knowledge, it even allows you to create and test the bot while designing, using the simulator.

First, you need to create your bot using the studio in The Ana app. After finalizing the desired chat flow, you can publish it to The Ana server and integrate it with various channels like Web, Android, iOS and Facebook. Ana server is responsible for serving published chatbot across different channels.

Creating a bot and testing using the simulator

  1. Open Ana app and Click on Studio
  2. Click on Add new chatbot to create a new project or 'Import chatbot' to import an existing project
  3. Enter the name of the new project and submit
  4. Create the desired chat flow and save it
  5. Click on RUN CHAT option to test chat flow locally using the simulator

Publishing bot to Ana server

  1. Ensure Ana server is up and running (Instructions for Ana server setup)
  2. Open Ana studio and configure Ana server URL
    1. Click on login
    2. Click on Add Ana chat server connection
    3. If it doesn't find any saved Ana chat server connections, you will be prompted to add new server connection, Click on Add Ana chat server connection
    4. Click on the drop-down, enter the server name and Ana api-gateway URL (ex: http://localhost:8080)
    5. Save changes
    6. Click on login, select recently added Ana server connection and enter username as 'Admin' and password as 'ana123' and submit
    7. Now we have integrated Ana studio with Ana server successfully. Next, we need to create a business and submit flow to Ana server
  3. Now open the studio from home page and create a new project and publish chat flow or import an existing chat flow

Deploying your Ana chatbot

The following channels are supported for deploying your Ana chatbot. Follow the links for instructions.

  1. Web Chat
  2. Android
  3. iOS
  4. Facebook Messenger (Coming soon...)

Note

This is just the setup documentation. ANA Conversation Suite has much more scope than predefined flows. You can call your own APIs from the chat, capture and save information from the user. You can take different types of inputs like button clicks, text, image, video etc. For now, explore the code to get to know all the possibilities.

License

Ana Conversation Suite is available under the GNU GPLv3 license.