Repository files navigation

O projeto utilizaDocker, sendo ele a única dependência.

Para rodar a documentação basta executar o comando abaixo, que realizará o build da documentação e iniciar o servidor:

docker-compose up -d

Você poderá acessar a documentação localmente no endereço:http://localhost:4567

Por usarmos o Slate dentro do container Docker para "buildar" e rodar o projeto, toda atualização dele, deve ser feita atualizando a versão daimagem oficial do Slate nodocker-compose.yml. Sendo recomendado configurar uma versão específica, para termos controle de qual versão estamos usando. Maiores detalhes sobre o uso Slate com Docker estão naWiki do Slate.

Estamos usando o GitHub Actions como CD e o GitHub Pages como hospedagem.

A configuração do workflow de CD está nodeploy.yml, onde cada passo está comentado para facilitar o entendimento.

O deploy é realizado automaticamente, sempre que a branchmain é atualizada, e a documentação fica acessível no endereçoapi-docs.recebiveis.fintera.com.br.