JSON to Xatkit Chatbot JAVA Parser

Easy and replicable JSON to Xatkit Definition parser

Report Bug · Request Feature

About The Project

One of the main features I have been missing in Xatkit has been to be able to create basic chatbots in a simple way, making API calls, or using a standardized format such as JSON for the definition of a chatbot. This can make the entry to the project much more friendly.

Here's why:

• I don't need to fully understand how to work the Fluent definition or the internal DSL that Xatkit employs when designing a chatbot.
• I don't need to install project dependencies such as Maven, JDK, Git... in order to run a chatbot, whose internal technology is transparent to the standard user.
• I don't need to learn Java to be able to create a chatbot, whose internal technology is transparent to the standard user.

Of course it is important to know all these technologies, but only if I want to contribute to the project by collaborating. A standard user does not have to know about all these topics, and can make potential users remain potential users. For this, I have designed a JSON parser to Xatkit Chatbot Java Definition (XCJD) so that from any web service, using a standardized and visual language like JSON that is also compatible with any web application, you can create the Java file that you will then run to create your amazing chatbot.

The main goal is to consume this project from any other project where you want to use this parser. Specifically, for Xatkit-SPL-Backend, we have added this project as a submodule and when the user creates his Chatbot from the interface in a simple and visual way, this generates the JSON that will be transformed into XCJD.

(back to top)

Built With

• Java
• Maven
• JSON Parser
• JSON Path

(back to top)

Getting Started

Prerequisites

To run and test this project locally, you must have Maven, Java JDK +8 and Git installed. If you just want to consume the project independently, you can create a Dockerfile with the following instructions:

RUN echo ${CHATBOT_DEFINITION} > /app/xatkit-spl-parser/src/bots/${CHATBOT_NAME}/${CHATBOT_NAME}.json
RUN mvn clean compile
RUN mvn exec:java -e -Dexec.mainClass="com.xatkit.spl.parser.XatkitParser" -Dexec.args="/app/xatkit-main/xatkit-spl-parser/src/bots/${CHATBOT_NAME}/${CHATBOT_NAME}"

(Where ${CHATBOT_DEFINITION} is the JSON that will be copied into ./src/bots/CHATBOT_NAME)

Installation

1. Clone the repo:

   git clone https://github.com/joszamama/xatkit-spl-parser.git

2. Install the Maven dependencies:

   cd xatkit-spl-parser
   mvn clean compile

3. Add the JSON of your chatbot to the folder ./src/bots and execute the following command:

   mvn exec:java -e -Dexec.mainClass="com.xatkit.spl.parser.XatkitParser" -Dexec.args="./src/bots/JSON_FILE"

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the EPL-2.0 license. See LICENSE.md for more information.

(back to top)