Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.68 KB

readme.md

File metadata and controls

45 lines (34 loc) · 2.68 KB

Documentação

Bem-vindo(a) à documentação do site do ALES! Aqui você vai encontrar todo tipo de informação, desde como subir o site localmente até definições de todos os termos técnicos usados.

Separamos a documentação em alguns arquivos e pastas pra facilitar sua navegação, mas sempre que introduzirmos um conceito novo ou mencionarmos uma tecnologia diferente, colocaremos links para outros arquivos da documentação com explicações mais aprofundadas.

Tabela de conteúdos

Estrutura do projeto

Em ordem alfabética, você encontrará as seguintes pastas no projeto:

.vscode

Essa pasta contém várias configurações do VS Code. Caso você não use VS Code, pode ignorar essa pasta

backend

Aqui estão todos os arquivos que configuram o backend do projeto. Caso você queira saber mais detalhes sobre o que são os arquivos dessa pasta, consulte a documentação dela.

compose

Esses arquivos estranhos configuram o Docker Compose que usamos tanto em desenvolvimento quanto em produção. Para entender por que existem tantos e pra que eles servem, dê uma olhada na documentação da pasta

docs

Essa pasta! Aqui está toda a documentação que você precisa pra entender o projeto.

frontend

Todos os arquivos do nosso frontend estão aqui. Para entender melhor o que eles são, veja a documentação da pasta

monitoring

Nessa pequena pasta ficam alguns arquivos usados para construir nossos serviços de monitoramento. Eles são usados para criar os containers do nosso Grafana e Prometheus usados apenas em produção.

scripts

Aqui você vai encontrar alguns scripts usados para subir o site tanto em desenvolvimento quanto em produção. Para entender melhor como eles funcionam, veja a documentação da pasta.