Template de Projeto

Este é um repositório template que tem como principal objetivo fornecer uma estrutura inicial para projetos da disciplina Trabalho Interdisciplina - Aplicações Web da PUC Minas.

Aqui você encontrará orientações de como estruturar o projeto e desenvolver seus respectivos artefatos.

Estrutura de Diretórios

Este template adota a seguinte estrutura de diretórios:

• docs
  • images
• src
  • assets
  • scripts
  • styles
  • vendor

O grupo é livre para alterar a estrutura proposta. No entanto, nesse caso, o arquivo README.md deve ser devidamente modificado para detalhar a nova estrutura e onde cada um dos artefatos produzidos estão localizados.

docs

Esta pasta arquiva a documentação dos projetos, sendo que o arquivo Projeto.md deve ser utilizado como documento principal, que concentra toda a informação do projeto em questão.

Este template fornece detalhes de todos os itens que o arquivo Projeto.MD deve conter, bem como orientações gerais de como os itens podem ser desenvolvidos.

Na pasta docs, há uma subpasta images que deve arquivar todas as imagens utilizadas para a elaboração do documento Projeto.md.

A presentação do projeto, deve ser entregue à parte em formato pdf e podem devem ser colocada no diretório docs.

src

Este diretório armazena o código fonte do projeto e adota uma hierarquia básica de projetos Web simples, que utilizam as tecnologias HTML, CSS e JavaScript:

• O diretório assets é utilizado para armazenar imagens, fontes e outros recursos utilizados no projeto.
• O diretório scripts armazena os arquivos JavaScripts do projeto
• O diretório styles é utilizado para os arquivos CSS
• o diretório vendor é reservado para incluir bibliotecas e frameworks utilizados no projeto como Bootstrap, jQuery, etc.

Orientações Gerais Sobre o Projeto

• Aprenda Markdown e Use-o para Documentar o Projeto (link 1 | link 2)