Skip to content

nathaliacosim/criminal-api-public

Repository files navigation

NestJS Logo

⚖️ Criminal API

API RESTful para gerenciamento de processos criminais, desenvolvida com NestJS e TypeScript.

NPM Version Package License CircleCI Coverage


📌 Sobre o Projeto

A Criminal API é uma aplicação backend desenvolvida com NestJS para controle e automação de processos criminais. É modular, escalável e preparada para produção.


🚀 Tecnologias Utilizadas


📦 Instalação

# Clone o repositório
git clone https://github.com/nathaliacosim/criminal-api-public.git

# Acesse a pasta
cd criminal-api-public

# Instale as dependências
npm install

▶️ Execução

# Modo desenvolvimento
npm run start:dev

# Modo produção
npm run start:prod

🧪 Testes

# Testes unitários
npm run test

# Testes end-to-end
npm run test:e2e

# Cobertura de testes
npm run test:cov

🔎 Documentação Swagger

Acesse após iniciar a aplicação:

http://localhost:3000/api

🗂️ Estrutura Sugerida

src/
├── modules/
│   ├── crimes/
│   ├── users/
│   └── auth/
├── common/
├── main.ts
└── app.module.ts

🤝 Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou enviar pull requests.


📄 Licença

Este projeto está sob a licença MIT.


👩‍💻 Desenvolvido por

Nathalia Cosim
GitHub
LinkedIn

About

API RESTful para gerenciamento de processos criminais, desenvolvida com NestJS e TypeScript.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published