From e7314d05b3d2de7406e43f771e2de6b9f76860c3 Mon Sep 17 00:00:00 2001 From: renansilvamaciel Date: Mon, 12 May 2025 10:38:56 -0300 Subject: [PATCH 1/2] DOC: Adding usage guide doc --- Dashboard - How To Use.txt | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Dashboard - How To Use.txt diff --git a/Dashboard - How To Use.txt b/Dashboard - How To Use.txt new file mode 100644 index 0000000..a50b4a7 --- /dev/null +++ b/Dashboard - How To Use.txt @@ -0,0 +1,22 @@ +# Dashboard - How To Use + +## 1. Configuração de Credenciais + +- Configure as credenciais no arquivo `app/configurations.py`, definindo os seguintes parâmetros: + - `MAESTRO_KEY` + - `MAESTRO_WORKSPACE` + - `MAESTRO_LOGIN` + +- Consulte a documentação oficial para obter essas informações: [Documentação BotCity - Ambiente de Desenvolvimento] (https://documentation.botcity.dev/pt/maestro/features/dev-environment/). + +### Observações importantes: +- Caso as variáveis ainda não estejam criadas no ambiente do sistema, será necessário **reiniciar a máquina** após a criação para que o sistema reconheça as novas variáveis. +- O **nome das variáveis** deve ser exatamente o mesmo utilizado no código. Elas podem ser customizadas, mas devem manter a consistência na chamada da função que lê essas variáveis. + +--- + +## 2. Preparação do Ambiente + +- Crie um ambiente virtual (venv) para o projeto: + ```bash + python -m venv venv From 42db9598d48291f27588d9a5cc6022ebff0f3902 Mon Sep 17 00:00:00 2001 From: Renan Silva Maciel Date: Mon, 12 May 2025 10:45:34 -0300 Subject: [PATCH 2/2] Update README.md update Signed-off-by: Renan Silva Maciel --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ade730a..a50b4a7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# Botcity_API_Dashboard -Dashboard created by consuming information from Botcity's Maestro API +# Dashboard - How To Use + +## 1. Configuração de Credenciais + +- Configure as credenciais no arquivo `app/configurations.py`, definindo os seguintes parâmetros: + - `MAESTRO_KEY` + - `MAESTRO_WORKSPACE` + - `MAESTRO_LOGIN` + +- Consulte a documentação oficial para obter essas informações: [Documentação BotCity - Ambiente de Desenvolvimento] (https://documentation.botcity.dev/pt/maestro/features/dev-environment/). + +### Observações importantes: +- Caso as variáveis ainda não estejam criadas no ambiente do sistema, será necessário **reiniciar a máquina** após a criação para que o sistema reconheça as novas variáveis. +- O **nome das variáveis** deve ser exatamente o mesmo utilizado no código. Elas podem ser customizadas, mas devem manter a consistência na chamada da função que lê essas variáveis. + +--- + +## 2. Preparação do Ambiente + +- Crie um ambiente virtual (venv) para o projeto: + ```bash + python -m venv venv