Executando o ambiente de desenvolvimento

Se você quiser contribuir com o Climweb você precisa configurar o ambiente de desenvolvimento em seu computador local. A melhor maneira de fazer isso é por meio do Docker Compose, para que você possa iniciar o aplicativo com o mínimo de complicações.

Nota

Para implantação de produção, visite https://github.com/wmo-raf/climweb-docker

Clonando o repositório

O primeiro passo é clonar o repositório Climweb do GitHub. Você pode fazer isso executando o seguinte comando em seu terminal:

$ git clone https://github.com/wmo-raf/climweb.git
$ cd climweb

Crie o arquivo .env

Em seguida, você precisa criar um arquivo de ambiente que contenha a configuração necessária para o ambiente de desenvolvimento. Você pode fazer isso copiando o arquivo de exemplo do ambiente de desenvolvimento fornecido no repositório:

$ cp .env.dev.sample .env

Atualize o arquivo .env com a configuração necessária. Consulte a seção Variáveis ​​de Ambiente para referência sobre as variáveis ​​de ambiente disponíveis e suas descrições.

Início rápido

Se você estiver familiarizado com git e Docker Compose, execute estes comandos para iniciar o ambiente de desenvolvimento do Climweb localmente, caso contrário, comece na seção Requisitos de instalação abaixo.

$ git clone https://github.com/wmo-raf/climweb.git

# Our supplied ./dev.sh script wraps Docker Compose setting the correct env vars for

# you to get hot code reloading working well.

$ ./dev.sh

# Run ./dev.sh help for further details.

$ ./dev.sh help

Requisitos de instalação

Se você ainda não instalou o docker e o Docker Compose em seu computador, siga as instruções em https://docs.docker.com/desktop e https://docs.docker.com/compose/install

Nota

Docker versão 19.03 é o mínimo necessário para construir o Climweb. No entanto, é altamente recomendável que você instale a versão mais recente do Docker disponível. Verifique se o seu docker está atualizado executando docker -v.

Você também precisará do git instalado, o que pode ser feito seguindo as instruções em https://www.linode.com/docs/development/version-control/how-to-install-git-on-linux-mac-and-windows.

Depois de terminar de instalar todo o software necessário, você poderá executar os seguintes comandos em seu terminal.

$ docker -v
Docker version 28.1.1, build 4eba377
$ docker compose version
Docker Compose version v2.35.1-desktop.1
$ git --version
git version 2.37.1

Se todos os comandos retornarem algo semelhante ao descrito no exemplo, você estará pronto para prosseguir!

Iniciando o ambiente de desenvolvimento

Primeiro, você precisa clonar o repositório. Execute os seguintes comandos para clonar o branch principal. Se você não estiver familiarizado com o git clone, isso fará o download de uma cópia do código do Climweb para o seu computador.

$ git clone https://github.com/wmo-raf/climweb.git
Cloning into 'climweb'...
...
$ cd climweb

Agora que temos nossa cópia do repositório e alteramos os diretórios para o climweb recém-criado, podemos abrir os contêineres.

Se não quiser usar o script dev.sh fornecido, você pode executar o seguinte comando para iniciar o ambiente de desenvolvimento:

$ docker compose -f docker-compose.yml -f docker-compose.dev.yml up

Nota

Observe que o arquivo docker-compose.dev.yml é usado para substituir o arquivo docker-compose.yml padrão com configurações específicas de desenvolvimento.

Acessando o aplicativo da web

Assim que os contêineres estiverem instalados e funcionando, você poderá acessar o aplicativo Climweb em seu navegador em http://localhost:8000. A porta pode ser alterada no arquivo .env se necessário, modificando a variável CLIMWEB_DEV_PORT.

Criando um superusuário

Para criar um superusuário para o aplicativo Climweb, você pode executar o seguinte comando em uma janela de terminal separada:

$ docker compose -f docker-compose.yml -f docker-compose.dev.yml exec climweb climweb createsuperuser

Mantenha o contêiner funcionando

Os contêineres precisam continuar funcionando enquanto você desenvolve. Eles também monitoram as alterações dos arquivos e os atualizam automaticamente, para que você não precise se preocupar em recarregar. Qualquer alteração no código acionará uma recarga e você poderá ver as alterações imediatamente.