Home
This repository contains the releases of the Xatkit framework. You can download the latest release here, or pick the one you need from the release list.
Each release contains two artifacts:
- xatkit_X.Y.Z.zip: the Xatkit runtime bundled with a list of preset platforms. The Xatkit runtime runs your digital assistants, stores logs and monitoring information, and manages your assistant's life-cycle. The list of bundled platforms is available in the release description.
- xatkit-update-site_X.Y.Z.zip: an Eclipse update site containing the Xatkit language editors. The editors allows to define intent libraries, platform specifications, and mix them in complex execution logic that can be executed by the Xatkit runtime.
1- Download the latest release and extract xatkit_X.Y.Z.
2- Setup the environment variable
Windows
Execute xatkit/install-windows.bat with administrative rights
Ubuntu
Execute xatkit/install-linux.sh
Xatkit Tip: don't waste your time!
This operation is only required the first time you install Xatkit
3- Navigate to xatkit/bin and start the example digital assistant
The example assistant is a basic web-based bot that greets users, it is defined in xatkit/examples/GreetingsBot.
Windows
./start-xatkit-windows.sh ../examples/GreetingsBot/GreetingsBot.propertiesUbuntu
./start-xatkit-linux.sh ../examples/GreetingsBot/GreetingsBot.propertiesThe console will log some initialization information, and after a few seconds you should see the following message:
You can test your chatbot here http://localhost:5000/admin (note that the bots behavior can be slightly different on the test page than when it is deployed on a server)Open your browser and navigate to http://localhost:5000/admin to test your deployed web-based bot!
Congratulations, you just started your first Xatkit digital assistant!
You can now have a look at the tutorial to learn how assistants are defined with the Xatkit language, or if you are already familiar with it you can take a look at the documentation for additional information on Xatkit capabilities. Note that the example Greetings Bot relies on regular expressions to process user inputs, you can take a look at this tutorial article to empower your bots with advanced Natural Language Processing and Machine Learning intent extraction.
If you experience any issue with Xatkit you can open an issue on our tracker and we will be happy to help you! Note that we may move your issue to a different repository based on the impacted components.
You want to contribute to Xatkit? We would love to hear from you and provide all the assistance we can! To ease the process we have created the Xatkit Development Toolkit (XDK), an all-in-one repository to build, test, and bundle Xatkit.
You can use the XDK to clone the Xatkit repositories and add your awesome contributions. Once you are ready, you can open a pull-request on the repository you updated and we will be happy to review your code and help you!
You have created a brand new platform for Xatkit? You can contact us and we will take a look at it! If you want to increase the visibility of your contribution we can create a dedicated repository for it in the Xatkit organization on Github.