Features • How To install • Contributing • License
⚡Actual release is : v0.2 - Blooming Barboiry
⚡
We want to create the most powerful and easiest tool for chatbot and virtual assistants creation, nurturing, analyzing and management. It gives you a total control on your robot, using transparent and free technology.
It combines:
- A cool graphical interface
- In-house NLP engine embedded 🔥 (openNLX), transparency : no dependencies to any NLP api nor black tricks
- Connectors to publish to Webchat and Facebook Messenger (soon available other platforms)
- webhooks and plugins integration
- Playground to instantly test your intents
- Analytics
We are working hard to add new features:
- Entities editor
- An interactive flow and scenarios display
- A better playground debugger
- other conversational UI components
- And more candies
- You could also request a feature
Opla is framed by a frontend and a backend. For details about development in each of those, please see front/README.md and backend/README.md.
We are using Javascript ES2018+, React, Node.js and other top notch tools.
The quickest way to run opla locally is to follow this guide
You will need :
- (required) a Kubernetes cluster with LoadBalancer support.
- (required)
nginx-ingress-controller
with an IP. Even better if you have a domain name pointing to that IP. - (required)
kubectl
locally - (required)
myke
(a yaml version ofmake
/Makefile) locally. See here for installation.` - (required)
tiller
,helm
- (optional)
cert-manager
for let's encrypt certificates, if needed. - (optional)
external-storage/snapshots
for snapshots and backups of your database, if you need them.
Helm charts get published at https://opla.github.io/opla You can fetch charts this way :
helm repo add opla https://opla.github.io/opla
helm repo update
helm fetch opla/opla-front opla/opla-backend
Install and deploy with helm
You can then install opla like any other helm application, and edit configuration by specifying your values.yaml or using helm --set ...
.
export API_DOMAIN=<YOUR_API_DOMAIN>
export FRONT_DOMAIN=<YOUR_FRONT_DOMAIN>
export NAMESPACE=test #to change if needed
helm upgrade --install --namespace ${NAMESPACE} \
--set namespace=${NAMESPACE} \
--set api.domain=${API_DOMAIN} \
--set front.domain=${FRONT_DOMAIN} \
front opla/opla-front
helm upgrade --install --namespace ${NAMESPACE} \
--set namespace=${NAMESPACE} \
--set api.domain=${FRONT_DOMAIN} \
backend opla/opla-backend
You can use --set api.domain=$IP.xip.io
--set front.domain=$IP.xip.io
as domain name if you only have an IP for your loadbalancer.
Your app is then available at http://${NAMESPACE}.${FRONT_DOMAIN}
In general, if you need more details about how we deploy opla, you can have a look at our CircleCI config.yaml, where we run commands to deploy it.
Please, see the CONTRIBUTING.md file.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See CODE_OF_CONDUCT.md file.
opla-front is released under the GPL v2.0+ License. See the bundled LICENSE file for details.