Manual de Instalação

Sistema de Compra Rápida de Passagem Aérea Integrado com IA - Projeto SkAI

1. Reconhecimentos e Direitos Autorais

Autores: Kauan Guilherme Alves Pinheiro Santos, Lilia Rosa Coelho Moura, Raylan Bruno Santana Carvalho, Virginia Maria Mondego Ferreira, Yasmin Cantanhede Santos.

Contato: kauan.santos@discente.ufma.br, liliarosaestudos@gmail.com, raylan.bruno@discente.ufma.br, virginiamondego@gmail.com, yasmin.cantanhede@discente.ufma.br

Última versão: 13/06/2025 | Versão: 1.0

Outros repositórios: kauanguilhermesantos, LiliaRosa19, Raylan-BR, VirginiaMond, yasmincantanhede

Agradecimentos: Universidade Federal do Maranhão (UFMA), Professor Doutor Thales Levi Azevedo Valente, e monitores da disciplina Projeto e Desenvolvimento de Software.

Licença MIT - Software Livre

Este material é resultado de um trabalho acadêmico da disciplina Projeto de Desenvolvimento de Software, sob orientação do Prof. Dr. Thales Levi Azevedo Valente (2025.1, Engenharia da Computação, UFMA). O conteúdo é licenciado sob a Licença MIT, permitindo uso acadêmico e comercial, desde que os autores sejam creditados.

Para detalhes, visite: https://opensource.org/licenses/MIT

O software é fornecido "como está", sem garantias. Os autores não se responsabilizam por danos decorrentes do uso.

2. Clonar o repositório para acessar o projeto

Para começar, certifique-se de que você tem instalado em sua máquina:

Para verificar se o Git e o Python estão instalados, abra o terminal e rode:

git --version
python --version

Se algum desses comandos der erro, faça a instalação:

Instalação no Linux (Debian/Ubuntu):

sudo apt update
sudo apt install git python3 python3-pip

Instalação no Windows:

Baixe e instale o Git para Windows e o Python para Windows.

Com tudo instalado, clone o repositório com o comando:

git clone https://github.com/Raylan-BR/SCRPAI-IA.git

Depois de clonar, siga para a configuração das dependências e variáveis de ambiente.

Acesso ao repositório do software: https://github.com/Raylan-BR/SCRPAI-IA.git

3. Instalar dependências (requirements.txt)

O arquivo requirements.txt lista as bibliotecas Python necessárias para o projeto.

Recomendamos criar um ambiente virtual para isolar essas dependências do seu Python global.

Criando ambiente virtual:

No terminal, navegue até a pasta codigo/backend:

cd codigo/backend

Linux/macOS:

python3 -m venv .venv
source .venv/bin/activate

Windows:

py -3 -m venv .venv
.\.venv\Scripts\activate

Depois que o ambiente virtual estiver ativo, instale as dependências com:

pip install -r requirements.txt

4. Configurar chaves de API

As chaves de API são necessárias para acessar serviços externos integrados no projeto, como MongoDB, Gemini (LLM), Google Client e Firebase.

Crie um arquivo chamado .env na pasta backend e insira as chaves no seguinte formato:

GOOGLE_API_KEY='sua_chave_gemini'
MONGO_URI='sua_chave_mongo'
GOOGLE_CLIENT_ID='sua_chave_google_client'
FIREBASE_ADMIN_CREDENTIALS_PATH='caminho_da_sua_chave_firebase'

Gerar as chaves:

1. API Key do LLM Gemini

  1. Acesse o site: AI Studio Google Gemini.
  2. Clique em "Get API Key".
  3. Escolha "Criar chave de API".
  4. Copie a chave gerada e cole no arquivo .env dentro de aspas simples, assim:
    GOOGLE_API_KEY='sua_chave_gemini'

2. API Key do MongoDB Atlas

  1. Acesse: MongoDB Atlas.
  2. Faça login ou crie uma conta.
  3. Crie um novo projeto e em seguida um Cluster.
  4. Após criado, vá em Database > Connect.
  5. Selecione Connect your application.
  6. Copie a URI gerada (algo como):
    mongodb+srv://usuario:senha@cluster.mongodb.net/?retryWrites=true&w=majority
  7. Cole essa URI no arquivo .env assim:
    MONGO_URI='sua_chave_mongo'

3. API Key do Google Client

  1. Acesse: Google Cloud Console.
  2. Crie ou selecione um projeto.
  3. Vá em APIs e Serviços > Tela de consentimento OAuth.
  4. Defina o tipo como Externo e preencha os campos obrigatórios.
  5. Vá para Credenciais > Criar credenciais > ID do cliente OAuth.
  6. Configure o tipo de aplicação como Web.
  7. Informe os URIs de redirecionamento (exemplo: http://localhost:4000/home.html).
  8. Copie o client_id e cole no arquivo .env assim:
    GOOGLE_CLIENT_ID='sua_chave_google_client'

4. API Key do Firebase

  1. Acesse: Firebase Console.
  2. Criar um projeto Firebase: Clique em Adicionar projeto → Começar
  3. Siga os passos: dê um nome ao projeto, aceite os termos, e finalize
  4. Vá no Firebase Console → Configurações do projeto → Contas de serviço (Service Accounts).
  5. Clique em Gerar nova chave privada (Generate new private key) → Baixar JSON.
  6. Coloque o arquivo json na pasta backend
  7. Configure a variável FIREBASE_ADMIN_CREDENTIALS_PATH no arquivo .env com o caminho do arquivo json. Ex:
    FIREBASE_ADMIN_CREDENTIALS_PATH=firebase-adminsdk.json

5. Rodar o sistema com Flask

Após configurar as chaves e instalar as dependências, siga os passos abaixo para iniciar o servidor local:

  1. Acesse a pasta backend (se ainda não estiver nela): 
    cd codigo/backend
  2. Inicie o servidor Flask:

    3. Linux/macOS:

    python3 main.py

    Windows:

    python main.py

Abra o navegador e acesse: http://localhost:5000/index.html

Se tudo estiver correto, as páginas HTML do projeto carregarão normalmente.

Contato

Para dúvidas, sugestões ou suporte, entre em contato com os autores: