This project is a module of Weni integrated inside Weni WebApp (Connect)
Chats is the official human service module of the Weni platform.
With a well-structured and optimized code, Chats provides Weni platform users with an intuitive, efficient and highly personalized human service experience.
This repository has been carefully developed with our customers' needs and concerns in mind, with the aim of providing an exceptional auto-service experience.
Before running the application, make sure you have installed the following tools on your machine:
- Node.js 18.16.1
- NPM or Yarn (recommended)
- Open the terminal and clone the repository
git clone https://github.com/weni-ai/chats-webapp.git
- Enter the created directory
cd chats-webapp
- Install the dependencies:
yarn
- Rename the .env.local.sample file to .env.local
- Configure the .env.local following the patterns below
| Variable | Type | Default | Description |
|---|---|---|---|
| VUE_APP_CHATS_API_URL | string |
Empty | URN of the backend environment to API requests. Without protocol (http/https) and without slash at the end. |
| VUE_APP_CHATS_WEBSOCKET_URL | string |
Empty | URL of the backend environment to WebSocket requests. With protocol wss and without slash at the end. |
| VUE_APP_CHATS_ENVIRONMENT | string |
develop |
Environment in which the project is running. Accepts develop, staging or production. |
...
Start the server with:
yarn run serve
After that, it will be available at http://localhost:8080.
| Command | Description |
|---|---|
| yarn | Install dependencies |
| yarn serve | 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 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 | Run all tests |
| yarn test --watch | Run test in watch mode |
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.
- Join our community chat to discuss with our internal team
- Join #dev for help from the community to development issues
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.
-
Please read our contribution guidelines for details on what and how you can contribute.
-
Report a bug by using this guideline for details on what and how you can contribute.