GUIA PARA RODAR O CHATGPT POLI

Este documento serve como um guia para o trabalho de conclusão de curso na modalidade software no curso de engenharia de controle e automação cursado na Universidade Federal da Bahia (UFBA). O guia fornece instruções passo a passo para iniciantes que desejam executar o projeto "chatgpt-poli", que consiste em um frontend desenvolvido em React e um backend em Python com Flask. É fundamental seguir todas as etapas com atenção para assegurar o correto funcionamento do projeto.

Índice

1. Pré-requisitos

   • 1.1 Baixaindo VSCode
   • 1.2 Baixaindo Python 3.11.0
   • 1.3 Baixaindo Node.js 18.12.1

2. Passo 1: Clonar o Projeto

   • 2.1 Abrir o VSCode
   • 2.2 Abrir o Terminal
   • 2.3 Clonar o Projeto do GitHub

3. Passo 2: Configurar o Backend

   • 3.1 Acessar o Site da OpenAI
   • 3.2 Criar uma Conta ou Fazer Login
   • 3.3 Gerar uma Chave de API
   • 3.4 Copiar a Chave de API
   • 3.5 Abrir o Terminal do VSCode
   • 3.6 Navegar até a Pasta do Backend
   • 3.7 Criar o Arquivo .env
   • 3.8 Abrir o Arquivo .env

4. Passo 3: Rodar o Backend

5. Passo 4: Rodar o Frontend

6. Passo 5: Acessar a Aplicação

Passo 1: Clonar o Projeto

1. Abra o VSCode após a instalação.

2. Abra o terminal no VSCode. Para fazer isso, clique em "Terminal" no menu superior e selecione "New Terminal."

3. No terminal, cole o seguinte comando para clonar o projeto a partir do repositório no GitHub:

   git clone https://github.com/eng-ufba/chatgpt-poli.git

Passo 2: Configurar o Backend

Antes de rodar o backend, você precisa configurar a variável de ambiente OPENAI_API_KEY.

1. Acesse o site da OpenAI.

2. Crie uma conta ou faça login em sua conta existente.

3. Navegue para a seção de chaves de API em https://platform.openai.com/account/api-keys.

4. Clique em "Create new secret key" para gerar uma nova chave de API.

5. Copie a chave API gerada.

6. Abra o terminal do VSCode.

7. Navegue até a pasta do backend usando o comando cd:

   cd chatgpt-poli/backend

8. Crie um arquivo .env no diretório do backend:

   touch .env

9. Abra o arquivo .env com um editor de texto, como o VSCode:

   code .env

10. Cole a chave API copiada no arquivo .env no seguinte formato:

    OPENAI_API_KEY=sua-chave-aqui

Passo 3: Rodar o Backend

Agora você pode rodar o backend.

1. No terminal do VSCode, navegue para a pasta raiz do projeto:

   cd ..

2. Volte para a pasta do backend:

   cd backend

3. Instale as dependências do Python listadas no arquivo requirements.txt com o comando:

   pip install -r requirements.txt

4. Após a instalação bem-sucedida das dependências, inicie o servidor Flask com o seguinte comando:

   python app.py

Passo 4: Rodar o Frontend

Agora, vamos configurar e executar o frontend do projeto.

1. No terminal do VSCode, volte à pasta raiz do projeto:

   cd ..

2. Navegue para a pasta do frontend:

   cd frontend

3. Instale as dependências do Node.js executando o comando:

   npm ci

4. Após a instalação das dependências do frontend, inicie o servidor de desenvolvimento com o seguinte comando:

   npm start

Passo 5: Acessar a Aplicação

Abra o seu navegador da web e digite o seguinte endereço na barra de endereços:

http://localhost:3000/chatgpt-poli

Agora, você deve conseguir acessar a aplicação que combina o frontend React e o backend Python com Flask.

Parabéns! Você conseguiu rodar o projeto com sucesso. Se você tiver alguma dúvida ou encontrar algum problema durante o processo, sinta-se à vontade para perguntar ou procurar ajuda em recursos de programação online.