PJP SYSTEM

Índice

• Descrição
• Funcionalidades
• Tipos de usuários
• Desenvolvedores
• Tecnologias utilizadas

Descrição:

• DESCRIÇÃO DO PRODUTO: O sistema deverá gerenciar uma loja de vendas online de computadores, placas de vídeo e processadores, facilitando a realização de compras e vendas.

Funcionalidades:

• Cadastro do usuário
• Login do usuário
• Realizar compra
• Alterar compra
• Excluir compra
• Cadastrar produto
• Alterar produto
• Excluir produto

Tipos de usuários:

• Cliente(usuário)
• Dono(admin)

Commits:

• Regras de commit

• feat: Uma nova feature

• fix: Correções de bugs

• docs: Alteração na documentção

• refactor: Refatorações que não são feature, nem melhoria

Práticas a seguir na codificação

• Nomes: Ao dar nomes a funções ou variáveis usar nomes intuitivos e de acordo com propósito da variavel ou função
• Funções: As funções devem ser pequenas com até 15 linhas e devem fazer apenas uma coisa
• Responsabilidade: As funções devem ser únicas ou seja, não devem ter duas funções que realizam as mesmas coisas
• Comentários: Se for comentar o código seja direto e breve com no máximo 30 caracteres, comente só se for realmente necessário
• Erros: Faça os tratamentos de exceções para que o seu código tenha o mínimo de erros possíveis
• Testes: Ao adcionar uma nova função ao sistema faça testes e verifique se ela está funcionando como deveria

Estrutura:

raiz/
├── docs (Documentação)
└── img (imagem usada no readme)
└── src (Códigos)

• docs(Documentação)
• img(imagem usada no readme)
• src(códigos)

Desenvolvedores:

• Pedro Henrique Maciel Alves
• Pedro Henrique dos Santos
• Jhonatan Gardioli Lourenço

Tecnologias utilizadas:

• Visual Studio Code - 1.69
• GIT - 2.25.1
• MySQL - 8.0
• HTML5, CSS3 e JavaScript com BootStrap
• NodeJs - 16.16.0
• Figma