Subir o ambiente de desenvolvimento

TLDR: Clonar com --recursive, rodar make setup.bootstrap uma vez e depois make start — o ambiente inteiro roda em Docker via Overmind.

Pré-requisitos

  • Docker
  • Docker Compose
  • Git

Passos

1. Clonar o repositório

O --recursive é obrigatório: o projeto usa submodules (.commons).

bash git clone --recursive git@github.com:ibft-corp/trg-club-api.git

2. Preparar o ambiente

Roda uma única vez. O comando pede as credenciais e confere as ferramentas necessárias.

bash make setup.bootstrap

3. Subir a aplicação

O servidor de desenvolvimento roda via Overmind.

Comando O que faz
make start sobe o servidor de desenvolvimento
make stop derruba o servidor de desenvolvimento

Comandos do dia a dia

Comando O que faz
make console abre o console do Rails
make shell abre um shell dentro do container
make clear limpa o ambiente (remove containers, volumes e networks) e recomeça do zero

Reconfigurar o ambiente

Na primeiríssima vez, se o bootstrap ainda não tiver rodado:

bash .project/init.sh

Para reconfigurar .commons, .claude e .env de um ambiente já existente:

bash make setup

Troubleshooting

  • Se o clone foi feito sem --recursive, rode git submodule update --init --recursive antes do bootstrap.
  • Se o ambiente ficar inconsistente, make clear seguido de make setup.bootstrap recria tudo.

Referências