Skip to content

DOC: Adding usage guide doc #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

DOC: Adding usage guide doc #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7314d0
DOC: Adding usage guide doc
renansilvamaciel May 12, 2025
42db959
Update README.md
renansilvamaciel May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions Dashboard - How To Use.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
24 changes: 22 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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