api-next-marketplace

API do Ecommerce.

VESÃO DE SOFTWARE: vide package.json

NODE: 23.1.0 (CURRENT) Temporariamente para testes

Convenções de projeto

Abaixo uma relação de boas práticas:

• Utilizamos o código fonte do Github como fonte única de verdade.
• Utilizamos o banco como fonte única de verdade e mantemos o schema do Prisma em código para validação do mesmo.
• Sistema de roteamento é localizado dentro da pasta src/app.
• Sistema de regras de negócio está alocado dentro da pasta src/rules.

Comandos

• npm i Instala as dependências.
• npm run dev Inicia em modo desenvolvimento.
• npm run test Inicia os testes.
• npm run build Compila a aplicação.
• npm run prepare-database Sobe seu banco pela primeira vez, sem utilizar restore (banco vazio).
• npm run database-cleanup Limpa todas as tabelas e popula elas com dados ficticios.
• npm run database-to-schema Transforma o banco de dados em schema.
• npm run schema-to-database Transforma o schema em banco de dados. Caso você não restaure pelo backup, as triggers não funcionaram desde que o prisma.schema não suporta guardar tais informações.
• npm run prisma-client-generate Gera o cliente do prisma.
• npm run database-dump-all Popula as tabelas com informações ficticias/iniciais.
• npm run database-drop-all Apaga os conteudos das tabelas.

Desenvolvendo

• Instale as dependências.
• Faça o restore do arquivo marketplace que consta na pasta backups.
• Rode o comando npm run database-to-schema.
• Popule sua tabela npm run database-dump-all (opcional).
• Rode a aplicação em desenvolvimento com npm run dev

Atualização de datas e geração de etags não funcionará se você não realizar o restore.

Documentação

Detalhes sobre a utilização do software.

Banco de dados

Abaixo segue a estrutura do banco de dados. Atualizado última vez em (19/11/2024).

HTTP RestAPI

Importe a coleção do Postman encontrada em docs/postman.json para maior detalhes de todos os end points.

Em breve mais atualizaçãoes sobre a documentação.