Ir para o conteúdo

Introdução

O setup do sistema é uma etapa fundamental para garantir o correto funcionamento da aplicação. Neste guia, apresentamos as instruções necessárias para configurar o ambiente de desenvolvimento e produção do sistema, incluindo a instalação das ferramentas e dependências necessárias.

Ambientes

O sistema possui dois ambientes principais: desenvolvimento e produção. Cada ambiente possui suas próprias configurações e dependências, que devem ser instaladas de acordo com as instruções fornecidas em cada seção.

Pré-requisitos

  • Sistema Operacional: Tanto para o ambiente de desenvolvimento quanto para o ambiente de produção, é necessário o uso de um sistema operacional unix-like, recomendamos o uso do Ubuntu 24.04 LTS.
  • Docker e Docker Compose: O sistema utiliza o Docker para gerenciar os containers da aplicação. Para instalar o Docker, siga as instruções disponíveis no site oficial do Docker.
  • Virtual Studio Code: Recomendamos o uso do Visual Studio Code como editor de código para o desenvolvimento do sistema.
  • Git: O sistema utiliza o Git para controle de versão do código fonte. Para instalar o Git, siga as instruções disponíveis no site oficial do Git.
  • Sistema Embarcado: Para o ambiente de produção, é necessário um microprocessador Raspberry Pi. recomenda-se o uso do Raspberry Pi 5, junto do sistema operacional Raspberry Pi OS e instalação do Docker. Há também requisitos de hardware para a aplicação embarcada, que serão detalhados na seção correspondente.
  • Expo Go: Para o ambiente de desenvolvimento, é necessário instalar o aplicativo Expo Go em seu dispositivo móvel para acessar o dashboard.

Estrutura básica do Projeto

O projeto é dividido em modulos, cada um responsável por uma parte específica da aplicação. A seguir, apresentamos a estrutura do projeto e os modulos que compõem o sistema.

  • Diretório.github/
    • Diretórioworkflows/
      • pages.yml # CI de auto-deploy da documentação
    • renovate.json # Configuração do Renovate para atualização automática de dependências
  • Diretóriodocs/ # Documentação do projeto
  • Diretóriosrc/ # Código fonte do projeto
    • Diretórioai-processor/ # Processador de vídeos
    • Diretóriobackend/ # Backend da aplicação
    • Diretóriodashboard/ # Frontend da aplicação
    • Diretóriodatabases/ # Banco de dados local
    • Diretórioload_test/ # Teste de carga
    • Diretóriometabase/ # Metabase para análise de dados
    • Diretóriopyxis/ # Simulador da estação médica Pyxis
  • .gitignore # Arquivo de configuração do Git
  • README.md # Orientações gerais sobre o projeto
  • 2024-1B-T02-EC10-G03.code-workspace # Workspace para o Visual Studio Code

Workspace

Para ir para as seções de configuração dos ambientes de desenvolvimento e produção, primeiro é necessário iniciar o ambiente de desenvolvimento. Para isso, siga as instruções abaixo:

  1. Clone o repositório do projeto em sua máquina local utilizando o comando:

    Terminal
    git clone git@github.com:Inteli-College/2024-1B-T02-EC10-G03.git
  2. Vá para o diretório do projeto:

    Terminal
    cd 2024-1B-T02-EC10-G03
  3. Abra o projeto no Visual Studio Code com o Workspace fornecido:

    Terminal
    code 2024-1B-T02-EC10-G03.code-workspace

    Ou abra o projeto manualmente no Visual Studio Code e abra o arquivo 2024-1B-T02-EC10-G03.code-workspace, depois clique em “Abrir o Workspace”.

  4. Agora você está pronto para prosseguir com a configuração dos ambientes de desenvolvimento e produção do sistema.

Ambientes

Agora que você já conhece os pré-requisitos necessários e a estrutura do projeto, vamos prosseguir com a configuração dos ambientes de desenvolvimento e produção do sistema.