💡 Resumo: Uma frase curta explicando o que o sistema faz e o problema que ele resolve.
- Instituição: Senac
- Curso: [Ex: Análise e Desenvolvimento de Sistemas]
- Semestre: [Ex: 3º Semestre]
- Disciplina(s): [Ex: Projeto Integrador III]
| Nome | GitHub | Papel/Foco |
|---|---|---|
| [Seu Nome] | @SeuUser | [Ex: Full Stack / Tech Lead] |
| [Nome do Colega] | @UserColega | [Ex: Frontend / Documentação] |
- Frontend: [Ex: Angular, TypeScript, HTML/SCSS]
- Backend: [Ex: Java, Spring Boot]
- Banco de Dados: [Ex: SQL Server]
- Ferramentas: [Ex: GitHub Projects, Postman]
Este repositório segue a estrutura:
backend/ <-- código-fonte do backend (API, regras de negócio)
frontend/ <-- código-fonte do frontend
docs/ <-- documentação técnica do projeto
Na pasta /docs você encontrará a documentação técnica, incluindo:
- Estrutura Analítica do Projeto (EAP/WBS)
- Modelagem do Banco de Dados (MER/DER)
- Protótipos de Interface
💡 Se quiser publicar essa documentação como uma página simples, o GitHub Pages pode usar a pasta
/docscomo fonte direto nas configurações do repositório — sem precisar de CI/CD.
O que é necessário ter instalado na máquina antes de rodar?
- [Ex: Node.js v18+]
- [Ex: Java 17+]
- [Ex: SQL Server]
- Clone o repositório:
git clone https://github.com/SenacOS/nome-do-repositorio.git
- Configure as variáveis de ambiente (renomeie
.env.examplepara.env, se houver). - Instale as dependências:
npm install # Exemplo para o frontend - Execute o projeto:
npm start # Exemplo para iniciar o frontend
Este projeto está sob a licença MIT — veja o arquivo LICENSE para mais detalhes.
Projeto acadêmico desenvolvido como parte da formação em tecnologia no Senac Brasil, hospedado na organização SenacOS.