Documentação - GenStock

Status do projeto: 🟢 Ativa | Em atualição contante

Status da documentação: 🟡 Em desenvolvimento

Visão geral

Esta documentação reúne as especificações técnicas, regras de negócio e detalhes de implementação da GenStock. O projeto consiste em uma API desenvolvida para consolidar conhecimentos fundamentais de backend, segurança e interação com o banco de dados relacional.

Objetivo do Produto

Criar um sistema de gerenciamento de usuários e controle de estoque vinculado. O foco principal não é apenas a funcionalidade, mas a aplicação correta de conceitos como arquitetura em camadas, tratamento de erros e segurança de dados sensíveis.

Arquitetura de software

Atualmente, o projeto segue a arquitetura em camadas, para maior fluides, legibilidade e organização da API.

Controller: (src/controller):
- Responsável apenas por receber a requisição HTTP (req), validar dados básicos e responder ao cliente (res).
- Serão divididas por domínio: userController.js e componentsController.js.
Service (src/service):
- Camada responsável pelo controle de todas as Regras de Negócio.
Database (src/database):
- Conexão e controle de banco via MySQL (mysql2/promise)

Técnologias

Tecnologia	Motivo
Node.js &
Express	Pela baixa latência e facilidade em criar APIs JSON de forma rápida e escalável.
MySQL (Driver Nativo)	Optei por não usar ORMs (como Sequelize ou Prisma) neste momento para reforçar o aprendizado de SQL Puro e entender como as queries funcionam "por baixo dos panos".
Bcrypt	Para garantir a segurança das senhas, utilizando hashing com salt, evitando armazenar senhas em texto plano (segurança básica essencial).
Dotenv	Para gerenciar variáveis de ambiente e não expor credenciais do banco no código fonte.