ICar - Sistema Web de locação de veículos
TIME:
David JC , Andreia Silva, Luiz Henrique
Descrição:
Projeto Final da Discipina de Engenharia de Software do Curso de Ciência da Computação na UFLA(Universidade Federal de Lavras) e têm como objetivo atender o gerenciamento comercial locação de veículos da empresa iCar.
Árvore de Pastas
Projeto Icar
├─ 📁 requisitos
├─ 📁 padroes_adotados
└─ 📁 App
├─ 📁 back-end
└─ 📁 front-endEstrutura das pastas:
Requisitos: Essa pasta contém a documentação referente aos requisitos, incluindo os diagramas.
- Diagrama de casos de uso.
- Documento de requisitos.
- Prototipos de interface.
- Requisitos.
Padrões adotados: Essa pasta contém Regras de Verificação e Análise de Requisitos.
- Regras de verificação e ánalise de requisitos
APP: Essa contém as pastas com o back-end e com o front-end.
TECNOLOGIAS UTILIZADAS:
-
Biblioteca: NodeJs - Versão: 19.8.1
-
Linguagem: JavaScript - Versão: 10.2.154.23-node.22
-
Banco de Dados: MySQL - Versão: 8.0.32
-
Servidor: Express - Versão: 4.18.1
-
Front End: React com TypeScript
-
Diagrama de casos de uso: Lucid.app
HOSPEDAGEM:
- Github Pages: []() - Versão: 0.0
Boas práticas de programação:
-
Nomenclatura clara e significativa
- Use nomes de variáveis, funções e classes que sejam descritivos e transmitam claramente o propósito e a função do elemento.
-
Separação de responsabilidades
- Siga o princípio da responsabilidade única, onde cada função ou classe deve ter uma única responsabilidade ou tarefa bem definida.
-
Comentários
- Utilize comentários de forma estratégica para explicar trechos de código complexos.
-
Indentação e formatação consistente
- Utilize uma formatação consistente em todo o código para garantir que seja facilmente legível.
-
Evite repetição de código
- Identifique padrões e trechos de código repetidos e abstraia-os para funções, métodos ou classes reutilizáveis.
-
Elimine código morto e não utilizado
- Revise regularmente seu código em busca de trechos de código que não são mais utilizados ou não têm efeito no funcionamento do programa e remova-os completamente.
Regras de utilização do git:
- Cada commit deve conter mudanças relacionadas a uma única funcionalidade.
- Explique o que foi alterado no commit.
- Antes de iniciar um novo trabalho ou fazer um commit, certifique-se de que seu repositório local esteja atualizado com as últimas alterações da branch remota.
- Crie e mantenha um arquivo .gitignore no seu repositório para evitar que arquivos e diretórios desnecessários sejam incluídos no controle de versão.
- Todo o código deve estar em App.