Skip to content

Ilhasoft/bothub-webapp

Repository files navigation

Bothub

BotHub is an open platform for predicting, training and sharing NLU (Natural Language Understanding) datasets in multiple languages in a cooperative way.

With BotHub, you can not only create NLP datasets, but you can also access, use and evolve datasets that were already built by other users in the community!

These collaboration methods + integration options make it easier for the user to apply NLU concepts in different platforms and contexts.

Build Status Coverage Status Node License

Bothub Webapp

bothub IMG

What's here

This repo is the Front-end repo for all Bothub-related projects. It hosts the documentation and other misc. resources for Bothub. Code for other projects, like the Engine, NLP Worker, NLP API and NLP On Demand, are hosted in other repositories.

Contents

Documentation

All documentation available on docs.bothub.it.

Get Started

First, clone this repository

git clone git@github.com:bothub-it/bothub-webapp.git

Development Workflow

To start running bothub, use these commands:

Use yarn commands to install, start, build, lint and test-watch.

Command Description
yarn install Install dependencies
yarn start serve with hot reload at localhost:8080
yarn build Build for production with minification
yarn build --report Build for production and view the bundle analyzer report
yarn lint Show lint warnings and errors
yarn test:unit Run all tests
yarn test:unit --watch Run test in watch mode

Environment Variables

You can set environment variables in your OS or write on .env file.

Variable Type Default Description
API_BASE_URL string In development mode is http://localhost:8000/api bothub-engine HTTP service API URL
BOTHUB_NLP_BASE_URL string In development mode is http://localhost:2657/ bothub-nlp Bothub NLP service URL
BOTHUB_WEBAPP_BASE_URL string In development mode is http://localhost:8080/ bothub-webapp Bothub Webapp service URL
SUPPORTED_LANGUAGES string en|pt Check description and formatation in Supported_Languages environment variable
VERSION_ENABLED boolean In development mode is false Should Bothub show version belong to each repository*
MAILCHIMP_LOGIN string Empty Check MailChimp subscribe LOGIN URL*
MAILCHIMP_DATACENTER string Empty Check MailChimp subscribe DATACENTER URL*
MAILCHIMP_USER_ID string Empty Check MailChimp subscribe USER ID URL*
MAILCHIMP_LIST_ID string Empty Check MailChimp subscribe LIST ID URL*
BOTHUB_WEBAPP_USE_SENTRY boolean In development mode is false, in production mode is true Enable sentri.io tracking*
BOTHUB_WEBAPP_SENTRY string Empty Sentry.io DNS*
BOTHUB_WEBAPP_USE_HOTJAR boolean In development mode is false, in production mode is true Enable Hotjar tracking*
BOTHUB_WEBAPP_HOTJAR_ID string Empty Hotjar ID*
BOTHUB_WEBAPP_LIGHTHOUSE_KEY string Empty Helpdocs Lighthouse widget API key*
BOTHUB_WEBAPP_LIGHTHOUSE_ALGORITHM_ARTICLE_ID string Empty Helpdocs algorithm article id *
MailChimp subscribe URL: `https://[MAILCHIMP_LOGIN].[MAILCHIMP_DATACENTER].list-manage.com/subscribe/post?u=[MAILCHIMP_USER_ID]&id=[MAILCHIMP_LIST_ID]`

Contributing

Guidelines

If you want to contribute with bothub's projects, we made a guideline to help you. See here contributing guidelines for the appropriate contribution.

License