From 883615f8df1546dd034f44753d1bcad609054666 Mon Sep 17 00:00:00 2001 From: Sthefani Date: Mon, 31 Jul 2023 11:29:22 -0300 Subject: [PATCH] added readme template --- README.md | 205 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 118 insertions(+), 87 deletions(-) diff --git a/README.md b/README.md index be6db6ff..5228438e 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,122 @@ -
- -
-

Weni Integrations WebApp

-

- Front-end project of Weni's Integrations module! -

+ + +*This project is a module of [Weni](https://github.com/weni-ai) integrated inside [Weni WebApp (Connect)](https://github.com/weni-ai/weni-webapp)* + +
+ +# INTEGRATIONS + +Front-end project of Weni's Integrations module! +
-
- Table of Contents -
    -
  1. - About The Project - -
    2. -
  2. - Getting Started - -
    3. -
-
- -## About The Project - -[![Run Unit Tests, Lint Files and Build Project](https://github.com/weni-ai/weni-integrations-webapp/actions/workflows/test-and-build.yml/badge.svg?branch=main)](https://github.com/weni-ai/weni-integrations-webapp/actions/workflows/test-and-build.yml) -[![codecov](https://codecov.io/gh/weni-ai/weni-integrations-webapp/branch/main/graph/badge.svg?token=TZHJ6L2U7R)](https://codecov.io/gh/weni-ai/weni-integrations-webapp) - -Front-end project of Weni's Integrations module. Backend data is gathered from [Weni Integrations Engine](https://github.com/Ilhasoft/weni-integrations-engine). -This project is a module of [Weni WebApp](https://github.com/Ilhasoft/weni-webapp) - -### Built With - -* [Vue.js](https://vuejs.org/) -* [Unnnic](https://github.com/Ilhasoft/unnnic) - -## Getting Started - -To get a local copy up and running follow these simple example steps. - -### Prerequisites - -* [Node.js 14.x](https://nodejs.org/en/download/) -* [yarn](https://yarnpkg.com/getting-started/install) - -### Installation - -1. Clone the repo - ```sh - git clone https://github.com/Ilhasoft/weni-integrations-webapp.git - ``` -2. Install dependency packages - ```sh - yarn install - ``` -3. Create a `.env` and enter the required environment variables - ```sh - VUE_APP_API_BASE_URL=http://localhost:8001 - VUE_APP_USE_SENTRY=false - VUE_APP_SENTRY_ENVIRONMENT=develop - VUE_APP_SENTRY_DSN=your-sentry-dsn - ``` -4. Get it up running with - ```sh - yarn run serve - ``` -### Environment variables - -| Name | Type | Required | Default | Description | -|-------------------------------- |:------: |:--------: |:----------------------: |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| VUE_APP_API_BASE_URL | String | True | None | [Weni Integrations Engine](https://github.com/Ilhasoft/weni-integrations-engine) application url.| -| VUE_APP_USE_SENTRY | Bool | False | False | Boolean that defines if sentry should be used and notified on errors. | -| VUE_APP_SENTRY_ENVIRONMENT | String | False | None | Environment to be sent to sentry as metadata. | -| VUE_APP_SENTRY_DSN | String | False | None | Sentry's DSN Url | - - -## Build - -Docker can be used to create an image to be used in production environments. Any environment variable should be inserted as a new `build-arg`. - -```sh - $ docker build --build-arg VUE_APP_API_BASE_URL=http://localhost:8001 --build-arg VUE_APP_USE_SENTRY=false --tag integrations:webapp --file Dockerfile --no-cache . -``` \ No newline at end of file +
+ +# Technologies + +- [Vue 2](https://v2.vuejs.org/) +- [Sass](https://sass-lang.com/) +- [i18n](https://www.i18next.com/) +- [Axios](https://axios-http.com/ptbr/docs/intro) +- [Unnnic](https://github.com/weni-ai/unnnic) (Weni's design system) + +
+ +# Requirements +Before running the application, make sure you have installed the following tools on your machine: + +- [Node.js 14.x](https://nodejs.org/en) +- [NPM](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com/) (recommended) + +
+ +# Set up + +1. Open the terminal and clone the repository + +``` + git clone https://github.com/weni-ai/weni-integrations-webapp.git +``` + +2. Enter the created directory + +``` + cd weni-integrations-webapp +``` + +3. 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 | +|--|--|--|--| +| VUE_APP_API_BASE_URL | `string` | Empty | https://integrations-engine.stg.cloud.weni.ai +| VUE_APP_WHATSAPP_FACEBOOK_APP_ID | `string` | Empty | 378643010643999 +| VUE_APP_FACEBOOK_APP_ID | `string` | Empty | 2898752767103255 +| VUE_APP_LOGROCKET_ID | `string` | Empty | +| VUE_APP_HELPHERO_ID | `string` | Empty | m7dO0to4OK +| VUE_APP_PARENT_IFRAME_DOMAIN | `string` | Empty | https://dash-staging.weni.ai +| VUE_APP_FLOWS_IFRAME_URL | `string` | Empty | https://flows-staging.weni.ai + +
+ +## Tokens +... + +
+ +## Execution +Start the server with: + +``` + yarn serve +``` + +After that, it will be available at http://localhost:8080. + +
+ +# Development Workflow + +| 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: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. + +- 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. \ No newline at end of file