/ia-platform-frontend

Primary LanguageVue

codecov License: MPL 2.0

This project is a module of Weni integrated inside Weni WebApp (Connect)

🖥️ Artificial Intelligence

This repository is responsible for all Weni - Artificial Intelligence-related projects. It hosts the documentation and other misc. resources for Weni - Artificial Intelligence. Code for other projects, like the Engine, NLP Worker, NLP API and NLP On Demand, are hosted in other repositories.

About Artificial Intelligence

Weni - Artificial Intelligence is an open platform for predicting, training and sharing NLU (Natural Language Understanding) datasets in multiple languages in a cooperative way. with Weni - Artificial Intelligence, 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.

Usability documentation

ia-platform-frontend-preview

Main Technologies

Requirements

Before running the application, make sure you have installed the following tools on your machine:

Set up

  1. Open the terminal and clone the repository
  git clone https://github.com/weni-ai/ia-platform-frontend.git
  1. Enter the created directory
  cd ia-platform-frontend
  1. Install the dependencies:
  yarn

How to develop

Environment variables

  1. Configure the config.js following the patterns below
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 *

Development

Start the server with:

  yarn start

After that, it will be available at http://localhost:8080.

Development Workflow

Command Description
yarn 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

Open-Source Governance

The Weni Platform open source projects are governed by @weni-ai. Weni opens all its software parts under terms of an open-source license to reach potential users and partners mainly. Secondly, Weni wants to reach developers by building a community for some pieces that are more reusable in other businesses or software projects, such as NLP models or tools. Besides that, the openness of our software is also related to building trust by enabling our external stakeholders to audit the security of our software.

Community

  • Join our community chat to discuss with our internal team
  • Join #dev for help from the community to development issues

Contributing

We are looking for collaboration from the Open Source community! There's so much we want to do, including but not limited to: enhancing existing applications with new features, optimizing the NLP tasks and algorithms involved that boost accuracy, new communication channels and integrations.