ambiente_de_desenvolvimento.desenvolvimento - Crops-Team/guidelines GitHub Wiki

Desenvolvimento

Nesta página você encontrará orientações sobre o processo de desenvolvimento de projetos da empresa.

Important

‼️ POR FAVOR, LEIA AS INSTRUÇÕES COM ATENÇÃO ANTES DE PEDIR AJUDA.

Note

Esta página está defasada, especialmente no que diz respeito a instalação de ferramentas. Dependendo da disponibilidade, use Ambiente_de_desenvolvimento - Mac OS.

Serviços e Softwares

A Empresa usa diversos serviços online para auxiliar no trabalho de desenvolvimento, sendo que a maioria demanda uma conta cadastrada por se tratarem de dados privados. Para pedir acesso a algum projeto em que irá trabalhar, você pode entrar em contato com:

  • Michel Rocha da Silva
  • Rômulo Pulcinelli Benedetti

A empresa utiliza diversas ferramentas tanto na fase de projeto, desenvolvimento e implantação.

  • Serviços:
    • Drive (armazenamento de documentos, imagens, etc)
    • Miro (mapas mentais, diagramas, planejamento, etc)
    • Figma (wireframe, projetos de design de produtos)
    • PowerBI (análise e visualização de dados)
    • google colab (Jupyter Notebooks para explorar APIs, projetos e dados)
    • GitHub (hospedagem de código fonte, registro de imagens, CI/CD, etc)
    • Keeper (armazenamento e compartilhamento de credenciais, dados bancários, chaves privadas/públicas, etc)
    • AWS, GCP, etc (serviços cloud em geral)
  • Softwares:
    • Suite Office da Microsoft
    • VSCode (editor de texto voltado para desenvolvimento de software)
    • IDEs JetBrains (IDEs de desenvolvimento de software)
    • ArcGIS (análise e manipulação de dados de geolocalização)b:

Ambiente De Desenvolvimento (Contêineres)

É encorajado o uso de contêineres para desenvolvimento dos projetos. Contêineres facilitam colocar um ambiente de desenvolvimento de pé rapidament e de forma padronizada.

É recomendado seguir as práticas desta seção para facilitar sua vida, aqui você encontrará Instruções para preparar um computador Windows ou Linux para usar Docker como mecanismo de conteinerização de ambientes de desenvolvimento.

Geralmente, o procedimento necessário para criar, rodar e interagir com um ambiente devidamente configurado para o repositório em que você trabalhará, está documentado no README do repositório do mesmo.

Se não estiver, encorajamos que crie e/ou documente você mesmo com base em algum outro repositório da organização, ou com a ajude de algum colega na empresa.

Windows

Instruções para preparar um computador Windows para usar Docker para gerenciar ambientes de desenvolvimento.

Requisitos Mínimos

Software

  • Windows 11 64-bits Home, Pro, Enterprise ou Education, versão 21H2 ou superior;
  • Windows 10 64-bits Home e Pro versão 21H1 ou superior e Enterprise ou Education versão 21H2 ou superior;

Você pode verificar a versão do seu sistema usando o atalho de teclado Windows-Logo-Key + R, ditando winver e selecionando OK.

Hardware

Mínimo:

  • CPU Intel ou AMD 64-bits;
  • 8 GB de RAM;
  • suporte para virtualização a nível de BIOS (VT-D ou SVM);

Recomendado:

  • CPU Intel ou AMD 64-bits quad-core (i5 ou I3, Ryzen 5) ;
  • 16 GB de RAM;
  • 500 GB SSD;
  • suporte para virtualização a nível de BIOS (VT-D ou SVM);

WSL 2 (Windows Subsystem for Linux)

Para fazer uso pleno do Docker, você precisará conseguir rodar contêineres Linux. Para fazer isso em sistema Windows, é necessário ter a ferramenta WSL 2 instalada.

Instruções para instalar o WSL 2:

  • Aperte a tecla Windows-Logo-Key para procurar o programa PowerShell,
  • Clique no programa com o botão direito do mouse e escolha a opção Executar como administrador.
  • Adicione a seguinte linha de comando na janela do PowerShell:
    wsl --install
  • Pressione Enter.
  • Assim que a instalação terminar com sucesso, reinicie o computador. Ao reiniciar, espere, o sistema irá resumir o processo de instalação para instalar a distribuição Ubuntu em uma máquina virtual via WSL 2.

Para instruções mais detalhadas, olhar a documentação oficial da Microsoft.

Configurando Informações de Usuário do Linux

Após o processo de instalação do sistema operacional Ubuntu, você cairá na configuração de informações de usuário na linha de comando da máquina virtual:

Enter new UNIX username: _

Como nome de usuário, insira cropsteam e pressione enter. Em seguida será pedido que informe uma senha:

Ao digitar sua senha, os caractéres não aparecerão, não se preocupe, eles estão sendo digitados, digite a sua senha e pressione enter.

New password: _

Recomendamos que coloque a senha agrometeorologia. Ao fim, aparecerá o prompt de linha de comando:

cropsteam@DESKTOP-XXXXXXX:~$ _

Você pode fechar a tela, a instalação terminou com sucesso.

Docker

Você pode instalar o Docker diretamente através da distribuição Linux no WSL 2, ou pode instalar via Windows usando o Docker Desktop (recomendado).

Docker Desktop

leia todos os passos antes de aplicá-los, posteriormente, se for mais familiarizado com o terminal, segir a instalação via powershell logo abaixo pode ser mais fácil para você. Se precisar fazer a úlima etapa, provavelmente usar o comando powershell indicado logo abaixo será mais fácil.

  • Baixe o Docker Desktop para Windows;
  • Execute o arquivo baixado (Docker Desktop Installer.exe);
  • Quando perguntado, garanta que Usar WSL 2 em vez de Hyper-V está marcado na Página de Configuração;
  • Siga o restante das instruções no assistente de instalação;
  • Assim que a instalação terminar com sucesso, o instalador pedirá para sair
  • Clique no botão para sair e entre novamente;

Se você não sabe se a conta administrativa do Windows difere da sua conta pessoal, provavelmente não difere e você pode ignorar o passo seguinte, caso tenha problemas para conseguir rodar o docker, tente realizar o passo seguinte.

  • Se a conta administrativa do Windows difere da sua conta pessoal, você deve adicionar o seu usuário ao grupo docker-users. Rode o Gerenciador do Computador como administrador e navegue para grupos e usuários local > grupos > docker-users, clique com o botão direito e adicione o seu usuário ao grupo. Reinicie ou re-logue para que as mudanças tenham efeito;

Você pode fazer todo o processo descrito acima, via powershell:

  • Você pode instalar via PowerShell:
PS C:\...> Invoke-WebRequest -Uri 'https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe' -OutFile 'Docker Desktop Installer.exe'
PS C:\...> Start-Process 'Docker Desktop Installer.exe' -Wait install
  • E adicionar o seu usuário ao grupo docker-users:
PS C:\...> net localgroup docker-users  $env:UserName /add

Se você receber erro 1378, significa que seu usuário já pertence ao grupo e você não precisa adicioná-lo.

Agora você pode rodar o Docker Desktop:

Docker desktop no menu iniciar

Se você estiver tendo problemas de alto consumo de CPU Desative a verificação automática por atualizações nas configurações do Docker Desktop.

Para instruções mais detalhadas, olhar a documentação oficial do Docker Desktop.

Deste ponto em diante você pode clonar o repositório em que vai trabalhar e segir as instruções no README do repositório. Utilize o terminal do Ubuntu para as tarefas iniciais quando for trabalhar em um repositório:

  • Clonagem de repositórios;
  • configuração de chave SSH no GitHub;
  • etc;

Você pode encontrar o terminal do Ubuntu no menu iniciar (aperte Windows-Logo-Key).

Linux

Ubuntu

Red Hat Enterprise Linux (RHEL)

MacOS

Instalação do Docker Desktop

Ambientes de desenvolvimento convencionais

O ecossistema da Apple infelizmente ainda não tem uma solução de conteinerização que seja tão fácil de usar quanto o Docker Desktop para Windows e Linux.

Neste caso, para desenvolvimento local em máquinas com MacOS, você pode usar as ferramentas homebrew e asdf para instalar pacotes e gerenciar e isolar ambientes de desenvolvimento convencionais.

Homebrew

asdf

asdf é um gerenciador de versões de pacotes de linha de comando. Ele pode ser usa para instalar e gerenciar versões de pacotes como Python, Node.js, dentre outros.

Instalação

Para instalar o asdf no MacOS, você pode usar o homebrew:

$ brew install asdf
Node.js

Para instalar o Node.js com o asdf, você pode usar o seguinte comando:

$ brew install gpg gawk
$ asdf plugin-add nodejs https://github.com/asdf-vm/asdf-nodejs.git
Instalação de versões

Para instalar uma versão específica do Node.js, você pode usar o seguinte comando:

$ asdf install nodejs 14.15.4
⚠️ **GitHub.com Fallback** ⚠️