Skip to main content

Ambiente de desenvolvimento

Status: Finalizado ✅

Siga o tutorial do seu sistema operacional (OS), mas para entender melhor como ser um bom desenvolvedor, leia e veja todos os tutoriais.

Windows​

Para windows, lembre-se que você sempre vai acabar tendo que usar o kernel do linux e então vamos ter que usar WSL (Windows subsystem for linux).

Programas a instalar​

Python​

  1. Acesse o site https://www.python.org/downloads/
  2. Procure pela versão 3.9.x mais recente e clique
  3. Procure pelo instalador do Windows e baixe-o
  4. Ao abrir, clique para instalar
  5. Depois que o Python tiver instalado, adicione o seu executável à variável de ambiente PATH
    1. Para achar o executável, acesse o IDLE do Python e então execute os comandos:
      1. import sys
      2. sys.executable
    2. Depois copie o caminho
    3. Abra as configurações do Windows e vá em Sistema
    4. No menu esquerdo, clique em sobre e depois na parte direita, clique em Configurações avançadas de sistema
    5. Clique em Variáveis de ambiente
    6. Na sessão de variáveis de sistema, pesquise pela variável PATH e depois clique para edita-la
    7. Adicione mais um caminho para A PASTA DO EXECUTAVEL

Git​

Caso ainda não tenha, instalar o Git

JetBrains Toolkit​

Para instalar IDEs, baixar a toolbox da JetBrains

  1. Acesse o site https://www.jetbrains.com/toolbox-app/
  2. Depois de baixar, abra o instalador. Clique em instalar e em seguida em finalizar
  3. Abra o JetBrains Toolkit, pesquise por PyCharm Community e clique em instalar. Caso possua uma licença, prefira baixar a versão Pro

Visual Studio Code​

Para edição de código, baixar o Visual Studio Code

  1. Acesse o site https://code.visualstudio.com/Download
  2. Baixe e depois abra o instalador
  3. Passe pelo instalador colocando as configurações que prefere e depois clique em finalizar
  4. Abra o VS Code e instela plugins para o Python e para o Django

Visual Studio​

  1. Acesse o site https://visualstudio.microsoft.com/downloads/
  2. Clique para baixar a versão Community
  3. Abra o instalador
  4. Depois de alguns instantes irá aparecer uma janela para selecionar os "módulos" do Visual Studio. Na sessão de Desktop & Mobile, selecione o .NET desktop development e depois clique para instalar.

PostgreSQL​

Para bando de dados, instalar o PostgreSQL 12

  1. Acessar o site https://www.enterprisedb.com/downloads/postgres-postgresql-downloads
  2. Clique para baixar o de versão 12.10 do Windows x86-64
  3. Depois de baixar, abra o instalador
  4. Clique em próximo até que pessa para criar um usuário. Coloque o nome do usuário como postgres e a senha como admin. Clique em próximo até finalizar a instalação
  5. Abra o pgAdmin
  6. Insira a senha cadastrada
  7. Na parte esquerda superior, clique para expandir o conteúdo de Servers, depois de PostgreSQL
  8. Então clique com o botão direito em Databases, vá em create e depois em Database...
  9. Coloque obraplay como nome do bando de dados e depois clique em Save

Terminal do Windows​

Baixar o terminal do Windows (na Microsoft Store, versão produção - não preview)

  1. Acesse o site https://www.microsoft.com/pt-br/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab
  2. Clique em Instalar/abrir. Será aberto um popup para abrir a loja da Microsoft, clique em sim;
  3. Depois clique em instalar.

Elastic Beanstalk CLI (ED CLI)​

Essa é a ferramenta que utilizamos para fazer deploy tanto do frontend quanto do backend. Se preferir, tem a possibilidade de seguir de baixar o ED CLI pelo próprio tutorial da AWS.

Pré-requisitos:

  1. Git instalado
  2. Python igual ou superior à versão 3.7
  3. Ter o pipx instalado
  4. Ter o pacote virtualenv instalado

Caso não tenha o pipx instalado, rode o comando python -m pip install --user pipx no CMD. Pode rodar o comando em qualquer diretório. Depois rode o comando python -m pipx ensurepath para adiciona-lo ao PATH.
Para saber mais, visite o site de Dowload

Para que seja possível usar o comando pipx, será necessário fechar e abrir o CMD.

Caso não tenho o virtualenv instalado, rode o comando pipx install virtualenv no CMD. Pode rodar o comando em qualquer diretório, não terá diferença.
Para saber mais, visite o site de Download (utilize a instalação via pipx).

Para que seja possível usar o comando virtualenv, será necessário fechar e abrir o CMD.

Se todos os itens do pré-requisitos estiverem OK, clone o repositório de instalação do Elastic Beanstalk e rode o seu Script.

  1. Acessar o CMD indo na barra de pesquisa do Windows e digitando Prompt de comando
  2. Rode o comando git clone https://github.com/aws/aws-elastic-beanstalk-cli-setup.git para clonar o projeto. Pode ser clonado em qualquer pasta
  3. Depois rode o comando python .\aws-elastic-beanstalk-cli-setup\scripts\ebcli_installer.py

WSL​

Instalar WSL (versão 2.0)

Pacotes básicos​

Instalar os pacotes básicos de dev na WSL

Setar configurações​

Habilitar o modo de desenvolvedor​

  1. Vá até as configurações do windows. Aperte o botão do Windows no teclado e digite Configutações
  2. Depois clique em Atualização e Segurança
  3. No menu esquerdo, vá em Para desenvolvedores e então habilite o modo para desenvolvedor

Criar váriavies de ambiente​

  1. Abra as configurações do Windows e vá em Sistema
  2. No menu esquerdo, clique em sobre e depois na parte direita, clique em Configurações avançadas de sistema
  3. Clique em Variáveis de ambiente
  4. Na sessão de variáveis de sistema, crie as variáveis listadas abaixo utilizando o botão Novo
    • DJANGO_SETTINGS_MODULE=config.settings.local

Clonar repositórios dos projetos​

Cada projeto tem o seu repositório, sendo eles:

Abra o Prompt de comando, navegue até a pasta onde deseja clonar o projeto*, e então o comando git clone <repositório> sendo o <repositório> a url do repositório.

*É recomendado criar uma pasta apenas para guardar os repositórios do Obraplay

Fazer migrate do banco de dados​

As migrates são responsáveis por guardar as modificações feitas em um banco de dados local para que depois sejam aplicadas em outros bancos de dados. Caso o seu banco de dados esteja zerado, será necessário aplicar as migrates ao seu banco de dados local para que ele esteja com as tabelas, registros e outras coisas que são usados pelo projeto

  1. Abra o projeto da API utilizando o PyCharm.
  2. Abra o terminal do PyCharm e digite o comando python manage.py migrate para que seja feito o migrate

Configurar o Elastic Beanstalk CLI​

Se preferir, tem a possibilidade de configurar o EB CLI pelo próprio tutorial da AWS.

  1. Acesse o CMD indo na barra de pesquisa do Windows e digite Prompt de comando
  2. Rode o comando eb, assim abrirá o CLI do Beanstalk
  3. Na janela do Beanstalk, digite o comando eb init
  4. Depois selecione a região us-east-1 : US East (N. Virginia)
  5. Insira

PowerShell​

É recomendado que use o PowerShell como prompt de comando padrão para este projeto. Porém se você ainda não estiver habituado com essa ferramenta, pode usar outras de sua preferência como o CMD, ou o Git Bash.

Possíveis configurações no PowerShell​

Pode ser que na sua máquina o PowerShell não esteja configurado como autorizado a rodar alguns scripts, por questão de segurança, isso ocasionaria um erro na hora de rodar o projeto utilizando o yarn, por exemplo.

url

Dê uma olhada na documentação do poweshell sobre essa questão de Políticas de Execução.

Digite o comando Get-ExecutionPolicy -List no seu terminal.

Scope ExecutionPolicy
----- ---------------
MachinePolicy       Undefined
UserPolicy             Undefined
Process                 Undefined
CurrentUser            Undefined
LocalMachine        Undefined

Se o seu output for igual a esse, então você precisa configurar as permissões.

Digite o comando Set-ExecutionPolicy -ExecutionPolicy RemoteSigned no seu terminal, ele já deve ser o suficiente para você conseguir rodar os scripts no seu PowerShell.

Configurações/Programas opcionais​

  1. Habilitar o Hyper V para usar Docker (mais para o final do projeto quando já estivermos com a base de dados concreta)
  2. Instalar Ubuntu 20.04 como distribuição linux
  3. Instalar asdf (no linux) para versionamento de linguagens de programação

Tutoriais sobre possíveis configurações​

How to set up windows dev env

My Development Environment Set up on Windows to use Python for Web Dev & Data Science

A beginners guide to setting up a modern web development environment on Windows 10

MacOS​

Não será usado.

Linux​

Claramente existem diversas distros GNU/Linux. Por isso, o padrão é usar Ubuntu. Isso se deve ao fato de ser a distro mais usada, mais fácil de colocar em uso e também de facilitar o setup dos usuários de Windows com WSL.

A versão usada é sempre a última versão LTS (Long Term Support).

  1. Instalar os pacotes básicos de desenvolvimento em linux
  2. Instalar docker (mais para o final do projeto quando já estivermos com a base de dados concreta)
  3. Baixar a toolbox da JetBrains para instalar IDEs
  4. Baixar o VS Code
  5. Instalar asdf (no linux) para versionamento de linguagens de programação
  6. Instalar PostgreSQL

Tutoriais sobre possiveis configurações​

O Guia DEFINITIVO de UBUNTU para Devs Iniciantes

23 Best Things To Do After Installing Ubuntu