Skip to content

weni-ai/weni-integrations-webapp

Repository files navigation

Run Unit Tests, Lint Files and Build Project codecov

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

🖥️ Weni-Integrations-Webapp

Front-end project of Weni's Integrations module. Backend data is gathered from Weni Integrations Engine.

About Weni Integrations

Through Integrations, users of the Weni platform will be able to connect their chatbot with different communication channels. This project was carefully developed with the needs of our clients in mind, with the aim of unlocking the human potential of your organization.

Usability documentation

integrations-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/weni-integrations-webapp.git
  1. Enter the created directory
  cd weni-integrations-webapp
  1. Install the dependencies:
  yarn

How to develop

Environment variables

  1. Create the .env file
  2. Configure the .env following the patterns below
Variable Type Default Description
VITE_APP_API_BASE_URL string Empty URN of the backend environment to API requests. Without slash at the end.
VITE_APP_WHATSAPP_FACEBOOK_APP_ID string Empty WhatsApp Facebook App identifier
VITE_APP_FACEBOOK_APP_ID string Empty Facebook App identifier
VITE_APP_LOGROCKET_ID string Empty LogRocket identifier
VITE_APP_HELPHERO_ID string Empty HelpHero identifier
VITE_APP_PARENT_IFRAME_DOMAIN string Empty Weni Webapp URL
VITE_APP_FLOWS_IFRAME_URL string Empty Flows module URL

Development

Start the server with:

  yarn serve

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

Development Workflow

Command Description
yarn Install dependencies
yarn dev serve with hot reload at localhost:5173
yarn build Build for production with minification
yarn build --report Build for production and view the bundle analyzer report
yarn translations:build Build translations for production
yarn translations:suggest-from-pt-br Build translations for production with suggestions. Add at least one language in the translations file so that suggestions in other languages can be generated.
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.