DK Fashion - Documentação

Repositório da documentação do projeto DK Fashion.

Sobre a documentação

Esta documentação centraliza os principais artefatos da primeira entrega do projeto, incluindo:

• backlog do produto;
• requisitos não funcionais;
• arquitetura do projeto;
• modelagem do banco de dados;
• conteinerização do ambiente

Como executar localmente

1. Instale as dependências:

make install

1. Inicie o servidor local do MkDocs:

mkdocs serve

1. Acesse:

http://127.0.0.1:8000

Como executar com Docker

1. Construa a imagem e suba o container:

docker compose up --build

1. Acesse a documentação:

http://localhost:8000

1. Para encerrar:

docker compose down

Comparando os dois fluxos

Fluxo com ambiente virtual

• cria uma .venv local;
• instala os pacotes diretamente no seu sistema;
• executa mkdocs serve a partir do ambiente Python do projeto.

Fluxo com Docker

• cria uma imagem isolada com Python e MkDocs;
• sobe um container com a porta 8000;
• monta o projeto como volume, então alterações em docs/ e mkdocs.yml continuam refletindo no navegador.

Passo a passo recomendado

1. Entre na pasta do projeto.
2. Rode docker compose up --build.
3. Abra http://localhost:8000.
4. Edite os arquivos em docs/.
5. Veja o hot reload no navegador.
6. Ao terminar, rode docker compose down.

Se mudar o requirements.txt, reconstrua a imagem com docker compose up --build.

Estrutura do repositório

.
|-- docs/
|   |-- index.md
|   |-- contributing_guidelines.md
|   |-- user_history.md
|   |-- non_functional_requirements.md
|   `-- user_history/
|-- mkdocs.yml
|-- Dockerfile
|-- compose.yaml
|-- requirements.txt
`-- README.md

Equipe

Ana Luiza github.com/Ana-Luiza-SC	Gabriel github.com/SAnjos3	Leo github.com/leohssjr
Mateus github.com/MVConsorte	Yzabella github.com/redjsun	Pablo github.com/Pabloserrapxx
Bruno Bragança github.com/BrunoBReis

Tecnologias utilizadas

• MkDocs
• Material for MkDocs