AULA 23 / 61 · ACESSO GRATUITO

Raiz diretórios e porta de entrada

Graciliano TolentinoEngenharia Caracol · Edição 2.0
Nesta aula
  1. O projeto deve explicar onde começar
  2. Mapa preenchido da Oficina Caracol
  3. Trecho de README utilizável
  4. Procedimento de organização
  5. Erros e reparos
  6. Exercício resolvido e gate

O projeto deve explicar onde começar

A raiz é a pasta que contém o projeto. Um caminho identifica a localização de um arquivo a partir de alguma referência. Em pratica/src/catalogo.mjs, pratica é a raiz do pacote de estudo e src agrupa seu código. Se o terminal já estiver dentro de pratica, o caminho relativo para o mesmo arquivo é src/catalogo.mjs. Confundir essas referências pode fazer um comando procurar dados no lugar errado.

Uma estrutura pequena ajuda o iniciante a localizar responsabilidades. Ela não precisa imitar uma empresa grande nem antecipar todos os recursos possíveis. Crie diretórios para categorias presentes no trabalho e explique as convenções. Um arquivo chamado utilidades que acumula funções sem relação também não resolve a organização: o nome precisa indicar finalidade.

O README é o documento de entrada. Ele informa o que o projeto faz, como iniciar, quais comandos verificar e quais limites não podem ser esquecidos. Não deve exigir que o leitor percorra toda a história da conversa. S07, na seção de registro de alterações, trata do acompanhamento de arquivos; o histórico complementa a entrada, sem substituí-la.

Mapa preenchido da Oficina Caracol

CaminhoResponsabilidade
pratica/README.mdObjetivo, início rápido, verificações e limites
pratica/package.json e package-lock.jsonComandos do pacote e registro de instalação
pratica/src/catalogo.mjsValidar dados e selecionar casos públicos
pratica/src/operacoes.mjsSimular reservas idempotentes em memória
pratica/src/servidor.mjsServir API e arquivos estáticos autorizados
pratica/data/casos.jsonDados fictícios do catálogo
pratica/public/HTML, JavaScript do navegador e estilos
pratica/tests/Verificações automatizadas por responsabilidade
pratica/scripts/validate.mjsExecutar a validação definida pelo projeto
pratica/docs/Decisões, evidências, gates, riscos e continuidade

O navegador executa public/app.js; o Node executa os módulos do servidor e dos testes. A extensão não define sozinha o papel: o README e o comando de entrada explicam o ambiente. O diretório public contém arquivos que podem ser entregues ao navegador; isso não autoriza publicar qualquer arquivo da raiz. O servidor usa uma lista fixa de arquivos estáticos, conforme seu contrato.

Seis linhas relacionam as pastas data, src, public, tests, scripts e docs às suas funções. O README é a entrada do projeto.Ampliar diagrama
Pastas da Oficina Caracol por função. A separação acompanha responsabilidades. Não exige um arquivo por campo nem concentra todos os assuntos em um documento.

Trecho de README utilizável

markdown
# Oficina Caracol
Catálogo de serviços fictícios e simulação de reservas.
Sem cadastro, banco externo ou dados pessoais reais.

## Iniciar
Abra o terminal dentro desta pasta pratica.
Confira o runtime com node --version.
Execute npm ci, npm test e npm run validate.
Execute npm start e abra http://127.0.0.1:3000.
Encerre o servidor com Ctrl+C no terminal.

## Limites
Reservas ficam apenas na memória e somem ao reiniciar.
Snapshot e restore usam somente sandbox/recuperacao.
Verificações manuais de teclado devem ser registradas.
A versão testada e os resultados estão no registro de evidência.

Este trecho ensina uma sequência, sem inventar a versão de Node instalada nem afirmar que os comandos já passaram. Na edição entregue, o registro de evidência identifica o ambiente realmente testado. Se a pessoa não sabe em qual pasta está, resolva essa dúvida antes de executar o comando.

Procedimento de organização

  • Liste as categorias reais de arquivo e a finalidade de cada uma.
  • Mantenha uma porta de entrada e caminhos coerentes entre README, comandos e documentação.
  • Ao mover um arquivo, revise importações, carregamento de dados, testes e referências documentais.
  • Peça a alguém que localize entrada, dado e teste sem instruções verbais; registre a dificuldade encontrada. Na ausência dessa pessoa, registre o limite da autoinspeção.

Erros e reparos

ErroReparo
Pasta misc sem finalidadeClassificar seu conteúdo por responsabilidade real e renomear
Mover módulo e esquecer importaçãoAtualizar referências e repetir as verificações afetadas
README com comando fora da pasta corretaDeclarar diretório de execução e conferir o percurso desde a raiz

Exercício resolvido e gate

Dados: um colega quer mudar a regra de seleção de ativos, conferir a entrada e registrar o risco da mudança. Indique três caminhos e explique a ordem de consulta.

Ver solução comentada

Solução: começar por pratica/README.md para entender execução e limites; consultar pratica/src/catalogo.mjs e pratica/tests/catalogo.test.mjs para regra e prova; registrar a análise em pratica/docs/risco.md. O dado de exemplo fica em pratica/data/casos.json. Localizar o código não autoriza alterá-lo sem critério ou ignorar o consumidor HTTP.

  • Rubrica: localizar entrada, implementação, teste e dado; distinguir programa e documentação; informar que os comandos oficiais são executados dentro de pratica.
  • Gate: a navegação permite localizar esses itens, os caminhos citados existem no pacote entregue e as mudanças de estrutura não deixam referências quebradas. A verificação externa ainda não realizada deve permanecer declarada como pendência.

Fontes relacionadas

Consulte os limites e as seções de apoio de cada referência.

S07 S19
Conseguiu explicar o que aprendeu?

Tente o exercício antes de consultar a solução. Marque a aula para organizar sua leitura.

A conclusão desta leitura não equivale a certificação ou aceite de um projeto real. Teste os exemplos no escopo indicado e registre as limitações.