Ir para o conteúdo

Instalação local

Requisitos

Existem três formas de rodar essa aplicação localmente:

  • ou com a imagem Docker
  • ou gerando o binário a partir do código fonte
  • ou com Docker Compose

As duas últimas alternativas necessitam do código fonte. Você pode usar o Git para baixar o código do projeto:

$ git clone https://github.com/cuducos/minha-receita.git

Talvez seja necessário um sistema UNIX (Linux ou macOS), mas não tenho certeza pois não testei em Windows.

É necessário cerca de 150Gb disponíveis de espaço em disco para armazenar os dados:

  • Os arquivos da Receita federal tem cerca de 6Gb
  • O banco de dados PostgreSQL gerado utiliza cerca de 140Gb

Requisitos e instalação

Imagem Docker

Baixar a imagem com:

$ docker pull ghcr.io/cuducos/minha-receita:main

A partir do código fonte

  • Go versão 1.21

Depois de clonar o repositório, baixe as dependências e compile a aplicação para um diretório incluído no PATH, por exemplo:

$ go get
$ go build -o /usr/local/bin/minha-receita main.go

Docker Compose

Gere as imagens dos containers com:

$ docker-compose build

Execução e configurações

Várias configurações podem ser passadas para a CLI, e elas estão documentadas no --help de cada comando da aplicação.

Exemplos

Imagem Docker

$ docker run --rm ghcr.io/cuducos/minha-receita:main --help --help
$ docker run --rm ghcr.io/cuducos/minha-receita:main --help api --help

A partir do código fonte

$ minha-receita --help
$ minha-receita api --help

Docker Compose

$ docker-compose run --rm minha-receita --help
$ docker-compose run --rm minha-receita api --help

Variáveis de ambiente

Para facilitar a manutenção, algumas variáveis de ambiente podem ser utilizadas, mas todas são opcionais:

Variável Descrição
DATABASE_URL URI de acesso ao banco de dados PostgreSQL
PORT Porta na qual a API web ficará disponível
NEW_RELIC_LICENSE_KEY Licença no New Relic para monitoramento
TEST_DATABASE_URL URI de acesso ao banco de dados PostgreSQL para ser utilizado nos testes