From 9e110e198765e0a2f224451d27432560c5ed7620 Mon Sep 17 00:00:00 2001 From: Eruel6 Date: Mon, 15 Jul 2024 12:15:20 -0300 Subject: [PATCH] doc: atualizando getting started --- README.md | 2 +- docs/gettingStarded.md | 91 ++++++++++++++++-------------------------- 2 files changed, 35 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 84b1265a..4425add8 100755 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ Antes de iniciar, certifique-se de que você tenha os seguintes softwares instal ## Passo 4: Executar o docker compose De o seguinte comando para rodar o sistema: ```bash - docker compose up + docker compose -f docker-compose-local.yml up ``` ## Passo 5: Acessar o sistema diff --git a/docs/gettingStarded.md b/docs/gettingStarded.md index da43a964..99783f49 100755 --- a/docs/gettingStarded.md +++ b/docs/gettingStarded.md @@ -1,81 +1,58 @@ # Getting Started -Siga estes passos para configurar seu ambiente e começar: - -## Passo 1: Instalar o Python - -1. Acesse o [site oficial do Python](https://www.python.org/downloads/) para baixar e instalar o Python em seu computador. -2. Durante o processo de instalação, certifique-se de marcar a opção "Adicionar Python ao PATH" para poder executar o Python facilmente pelo terminal ou prompt de comando. - -## Passo 2: Instalar Bibliotecas Necessárias - -Abra o terminal ou prompt de comando e execute os seguintes comandos para instalar as bibliotecas necessárias: +Este projeto foi desenvolvido no Ubuntu LTS 22.04. Pode funcionar em outros sistemas operacionais, mas ainda não foi testado. Para rodar o projeto, siga as instruções abaixo: +## Pré-requisitos +Certifique-se de estar com o sistema atualizado, no terminal rode o seguinte comado: ```bash -pip install python-telegram-bot -pip install python-dotenv -pip install os + sudo apt update && sudo apt upgrade ``` +Antes de iniciar, certifique-se de que você tenha os seguintes softwares instalados na sua máquina: -## Passo 3: Configurar Seu Bot no Telegram - -1. Entrar em contato com o [@BotFather](https://web.telegram.org/k/#@BotFather) no Telegram. - -2. No chat com o BotFather, use o comando "/newbot" para criar um novo bot. - -3. Siga as instruções para fornecer um nome e um username para o seu bot. +- Git [guia de instalação](https://git-scm.com/download/linux) +- Docker e docker compose [guia de instalação](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) -4. Após a criação, o BotFather irá fornecer um token para o seu bot. Guarde esse token pois será utilizado no código Python. - -## Passo 4: Configurando o ambiente - -Siga estes passos para clonar o repositório, configurar o token do Telegram no arquivo `.env` e executar o bot do Telegram. - -### Clonar o Repositório +## Passo 2: Clonar o Repositório 1. Abra o terminal ou prompt de comando. 2. Clone o repositório usando o comando: - ```bash +```bash git clone https://github.com/ResidenciaTICBrisa/T2G2-Chatbot-Participacao-Social - ``` -### Acessar a Branch 'bot_telegram' - -1. Mude para a branch bot_telegram com o comando: - - ```bash - git checkout bot_telegram - ``` +``` -### Configurar o Arquivo .env +## Passo 3: Configurar o Arquivo .env 1. Crie um arquivo .env no diretório raiz do projeto. 2. Abra o arquivo .env com seu editor de texto preferido. -3. Adicione a seguinte linha ao arquivo .env e substitua SEU_TELEGRAM_TOKEN pelo token fornecido pelo BotFather: - - ```bash - TELEGRAM_TOKEN= 'SEU_TELEGRAM_TOKEN' - ``` - -## Passo 5: Executar o Bot do Telegram -1. Certifique-se de que você está no diretório do projeto. -2. Certifique-se de que você está na branch 'bot_telegram' com o comando: - - ```shell - git checkout - ``` - -3. Execute o script Python para iniciar o bot do Telegram: +3. Adicione a seguintes linhas ao arquivo .env e substitua os '*' pelas credenciais que deseja criar no botpress: ```bash - python chatbot.py + #Credenciais do postgres + POSTGRES_DB= * #Nome do dbanco de dados + POSTGRES_USER= * #Usuário postgress + POSTGRES_PASSWORD= * #Senha do usuário postgres + + #Credenciais da conta de administrador do pgadmin + PGADMIN_DEFAULT_EMAIL= * #email do usuário pgadmin + PGADMIN_DEFAULT_PASSWORD= * #Senha do usuário pgadmin + + #Credencias da conta administrador do botpress + BOTPRESS_ADMIN_EMAIL= * #Email da conta administrador + BOTPRESS_ADMIN_PASSWORD=* #Senha da conta administrador ``` +## Passo 4: Executar o docker compose +De o seguinte comando para rodar o sistema: +```bash + docker compose -f docker-compose-local.yml up +``` -O bot do Telegram deve estar agora em execução e pronto para interagir com os usuários. - -Parabéns! Você configurou e executou com sucesso o bot do Telegram. +## Passo 5: Acessar o sistema +Se tudo tiver sido da forma adequada, acesse o projeto através do +[http://localhost:3000](http://localhost:3000) # Histórico de versão | Versão | Data | Descrição | Autor | | :----: | :--------: | :---------------------------------------------------: | :--------------: | -| 1.0 | 03/04/2024 | Criação do documento | Gabriel Zaranza | \ No newline at end of file +| 1.0 | 03/04/2024 | Criação do documento | Gabriel Zaranza | +| 1.1 | 15/07/2024 | Atualização para versão atual | Arthur Taylor | \ No newline at end of file