RepositorioTemplate

Repositório que deve ser utilizado como template inicial pelos grupos da matéria de Arquitetura e Desenho de Software.

Introdução

Este repositório traz um template de repo de documentação a ser seguido pelos grupos de arquitetura e desenho de software.

---

Comando único para clonar e rodar o projeto do zero

Se quiser rodar tudo de uma vez (clone, venv, dependências e servidor) em sistemas baseados em Unix (Linux/macOS ou WSL), use:

git clone https://github.com/UnBArqDsw2025-1-Turma01/2025.1-T01-_G1_Embarcado_Entrega_03 && \
cd 2025.1-T01-_G1_Embarcado_Entrega_03 && \
python3 -m venv .venv && \
source .venv/bin/activate && \
pip install -r requirements.txt && \
mkdocs serve

Esse comando faz tudo automaticamente e inicia o servidor local com a documentação pronta para acessar em http://127.0.0.1:8000.

---

Tecnologia

A geração do site estático é realizada utilizando o Mkdocs.

"MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information."

---

1. Clone este repositório

git clone https://github.com/UnBArqDsw2025-1-Turma01/2025.1-T01-_G1_Embarcado_Entrega_03

2. Pré-requisitos

Configuração inicial do Git no Windows

Após instalar o Git, configure seu nome de usuário e e-mail globalmente (eles serão usados nos commits):

git config --global user.name "Seu Nome"
git config --global user.email "seu@email.com"

Você pode verificar as configurações atuais com:

git config --global --list

Ubuntu

Antes de criar o ambiente virtual, instale os pacotes necessários:

sudo apt update
sudo apt install -y python3 python3-venv python3-pip git

Windows

Instale o Python de uma das seguintes formas:

• Site oficial: https://www.python.org/downloads/windows/
• Microsoft Store (versão mais recente recomendada para iniciantes): abra a Microsoft Store, pesquise por "Python" e instale a versão mais recente disponível

Marque a opção "Add Python to PATH" durante a instalação.

Instale o Git: https://git-scm.com/download/win

Opcional: use o terminal PowerShell ou Git Bash para seguir os comandos com mais facilidade.

3. Crie o ambiente virtual

No diretório raiz do projeto, crie um venv chamado .venv:

python3 -m venv .venv

4. Ative o ambiente virtual

Linux/macOS

source .venv/bin/activate

Windows (PowerShell ou CMD)

.\venv\Scripts\Activate

Você verá o prefixo (.venv) no prompt quando o venv estiver ativo.

5. Instale as dependências

Com o venv ativo, instale o MkDocs e o tema Material:

pip install -r requirements.txt

6. Rode o ambiente de desenvolvimento

Ainda com o venv ativo, execute:

mkdocs serve

Acesse a documentação no navegador pelo endereço:

http://127.0.0.1:8000

---

7. Executar novamente o projeto rapidamente

Depois de já ter instalado os pré-requisitos, criado o ambiente virtual e instalado as dependências uma vez, você pode rodar novamente o servidor local da documentação com um único comando:

Linux/macOS:

source .venv/bin/activate && mkdocs serve

Windows (PowerShell):

.venv\Scripts\Activate; mkdocs serve

Esse comando ativa o ambiente virtual e inicia o servidor do MkDocs em sequência.