Pular para conteúdo

0. Pré-requisitos

Para começar os exercícios hands-on, precisamos preparar o nosso ambiente. Isso inclui instalar as ferramentas necessárias, configurar o espaço de trabalho e garantir que temos acesso aos recursos exigidos.

Para configurar o seu ambiente de desenvolvimento, consulte o apêndice Configuração do ambiente de desenvolvimento.

Depois disso, o seu ambiente deve estar pronto para os exercícios. Vamos criar um repositório raiz, para facilitar o acesso aos repositórios dos demais microsserviços e também à documentação.

Repositório raiz

O repositório raiz será o ponto central de acesso a todos os outros repositórios de microsserviços e à documentação. Ele ajuda a organizar a estrutura do projeto e a gerenciar as dependências de forma eficiente.

Para organizar melhor o projeto, propomos criar uma nova organização no GitHub, com um nome como <username>-studies, e então criar o repositório raiz dentro dessa organização, assim como os repositórios dos outros microsserviços. Dessa forma, fica fácil gerenciar permissões de acesso e colaborar com os outros membros da equipe. Além disso, podemos usar os recursos de gerenciamento de projetos do GitHub, como issues e pull requests, para acompanhar o progresso e coordenar o trabalho entre os diferentes repositórios.

Hospedagem da documentação

Além disso, podemos usar o GitHub Pages para hospedar a documentação do projeto.

Passos:

  1. Crie um novo repositório chamado platform dentro da organização e, em seguida, clone-o na sua máquina local. Esse repositório será o repositório raiz do nosso projeto.

  2. Dentro desse repositório raiz, podemos criar uma estrutura de diretórios para organizar os nossos microsserviços e a documentação. Por exemplo:

    Root Directory Structure
    📁 platform/
├── 📁 api/
├── 📁 docs/
│   └── Markdown index.md
├── 📁 web/
├── 📁 docker/
├── Git .gitignore
└── Markdown README.md

BÔNUS: MkDocs com Material

Você pode usar o MkDocs com Material para a documentação e hospedá-la no GitHub Pages. Assim, teremos um site de documentação bem estruturado, visualmente agradável e de fácil acesso para todos os membros da equipe.

Para configurar o mkdocs com material, você pode copiar a configuração do repositório modelo e adaptá-la às necessidades do seu projeto.

Copie para o repositório raiz os seguintes arquivos do repositório modelo: mkdocs.yml e requirements.txt

A estrutura de diretórios resultante ficará assim:

Root Directory Structure
📁 platform/
├── 📁 api/
├── 📁 docs/
│   └── Markdown index.md
├── 📁 web/
├── 📁 docker/
├── Git .gitignore
├── Markdown README.md
├── YAML mkdocs.yml
└──  requirements.txt

Depois de configurar o mkdocs, você pode gerar e servir a documentação localmente com os seguintes comandos:

python3 -m venv venv
source venv/bin/activate
python3 -m pip install --no-cache-dir -r requirements.txt --upgrade
mkdocs build
mkdocs serve

python -m venv venv
venv\Scripts\activate
python -m pip install --no-cache-dir -r requirements.txt --upgrade
mkdocs build
mkdocs serve

Isso inicia um servidor de desenvolvimento local, e você pode acessar a documentação abrindo http://127.0.0.1:8000 no seu navegador.

Agora, sem mais demora, você pode começar os exercícios hands-on!