🚀 Storagie Backend

Uma API REST robusta e escalável construída com NestJS, TypeScript e Clean Architecture, implementando padrões Domain Driven Design (DDD) para máxima flexibilidade e manutenibilidade.

📋 Índice

🎯 Sobre o Projeto
🛠️ Tecnologias
🏗️ Arquitetura
🚀 Início Rápido
📦 Instalação
⚙️ Configuração
🏃‍♂️ Executando
🔍 Scripts Disponíveis
📊 Monitoramento
🧪 Testes
📚 Documentação da API
🐳 Docker
🚀 Deploy
🤝 Contribuindo
📄 Licença

🎯 Sobre o Projeto

O Storagie Backend é uma solução completa de backend que oferece:

🏗️ Arquitetura Limpa com separação clara de responsabilidades
🚀 Performance otimizada com cache Redis e processamento assíncrono
🛡️ Segurança robusta com JWT, rate limiting e validação
📊 Monitoramento avançado com métricas em tempo real
🔄 Sistema de tasks para processamento assíncrono
🗄️ Suporte multi-banco (PostgreSQL, MySQL, SQLite)
📈 Escalabilidade horizontal preparada para microserviços

🛠️ Tecnologias

Core Framework

NestJS v11 - Framework Node.js progressivo
TypeScript v5.7 - Superset tipado do JavaScript
Fastify v5 - Framework web de alta performance

Banco de Dados & ORM

TypeORM v0.3 - ORM moderno e flexível
PostgreSQL - Banco principal para produção
SQLite - Banco para desenvolvimento
MySQL/MariaDB - Suporte opcional

Cache & Performance

Redis - Cache em memória e sessões
IORedis - Cliente Redis otimizado

Segurança & Validação

class-validator - Validação declarativa
class-transformer - Transformação de objetos
bcrypt - Hash de senhas
Passport - Autenticação flexível
@nestjs/throttler - Rate limiting

Monitoramento & Logs

@nestjs/terminus - Health checks
Pino - Logger de alta performance

DevOps & Qualidade

Docker - Containerização
ESLint - Linting de código
Prettier - Formatação de código
Jest - Framework de testes
SWC - Compilador rápido para TypeScript

🏗️ Arquitetura

Este projeto implementa Clean Architecture com Domain Driven Design:

src/
├── domain/           # 🏛️ Regras de negócio puras
├── application/      # 🎯 Casos de uso e orquestração
├── infrastructure/   # 🔧 Detalhes técnicos
├── presentation/     # 🌐 Interface com mundo externo
└── shared/          # 🔄 Recursos compartilhados

Benefícios:

✅ Testabilidade - Fácil criação de mocks e testes unitários
✅ Manutenibilidade - Código organizado e desacoplado
✅ Flexibilidade - Fácil troca de tecnologias
✅ Escalabilidade - Estrutura preparada para crescimento

📖 Documentação detalhada: ARCHITECTURE.md

🚀 Início Rápido

Pré-requisitos

Node.js ≥ 18.0.0
pnpm ≥ 8.0.0 (recomendado) ou npm/yarn
Redis ≥ 6.0 (opcional, para cache)
PostgreSQL ≥ 13 (para produção)

⚡ Quick Start

# 1️⃣ Clone o repositório
git clone <repository-url>
cd storagie/source/backend

# 2️⃣ Instale as dependências
pnpm install

# 3️⃣ Configure o ambiente
cp .env.example .env
# Edite o .env conforme necessário

# 4️⃣ Inicie os serviços (opcional)
pnpm docker:up

# 5️⃣ Execute em modo desenvolvimento
pnpm dev

# 6️⃣ Acesse a aplicação
# API: http://localhost:3000
# Health: http://localhost:3000/health
# Docs: http://localhost:3000/docs (se habilitado)

📦 Instalação

Usando pnpm (Recomendado)

pnpm install

Usando npm

npm install

Usando yarn

yarn install

⚙️ Configuração

1. Variáveis de Ambiente

Copie e configure o arquivo de ambiente:

cp .env.example .env

2. Configurações Essenciais

Para Desenvolvimento:

APP_ENV=development
APP_PORT=3000
DB_TYPE=sqlite
DB_DATABASE=./storage/database.sqlite
CACHE_ENABLED=true

Para Produção:

APP_ENV=production
APP_PORT=3000
DB_TYPE=postgres
DB_HOST=your-db-host
DB_DATABASE=storagie
# Configure secrets obrigatórios!
COOKIE_SECRET=your-secure-cookie-secret
JWT_SECRET=your-secure-jwt-secret

📖 Configuração completa: CONFIGURATION.md

3. Banco de Dados

SQLite (Desenvolvimento):

# Já configurado no .env.example
# Banco é criado automaticamente

PostgreSQL (Produção):

# Configure as variáveis no .env
DB_TYPE=postgres
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=storagie_user
DB_PASSWORD=your-password
DB_DATABASE=storagie

🏃‍♂️ Executando

Desenvolvimento

# Desenvolvimento com hot-reload
pnpm dev

# Debugging
pnpm debug

Produção

# Build
pnpm build

# Produção
pnpm prod

Com Docker

# Subir serviços (Redis + PostgreSQL)
pnpm docker:up

# Parar serviços
pnpm docker:down

# Desenvolvimento completo
pnpm dev:setup

🔍 Scripts Disponíveis

Desenvolvimento

pnpm dev - Modo desenvolvimento com hot-reload
pnpm debug - Modo debug
pnpm build - Build para produção
pnpm prod - Execução em produção

Banco de Dados

pnpm db:migration:generate <name> - Gerar nova migration
pnpm db:migration:run - Executar migrations
pnpm db:migration:revert - Reverter última migration
pnpm db:schema:sync - Sincronizar schema (⚠️ cuidado!)

Qualidade de Código

pnpm lint - Verificar linting
pnpm format - Formatar código
pnpm test - Executar testes
pnpm test:watch - Testes em modo watch
pnpm test:cov - Testes com cobertura

Docker

pnpm docker:up - Subir serviços
pnpm docker:down - Parar serviços
pnpm docker:logs - Ver logs dos serviços

📊 Monitoramento

Health Checks

# Health geral
GET /health

# Liveness probe
GET /health/live

# Readiness probe
GET /health/ready

# Métricas completas
GET /health/metrics

# Cache status
GET /health/cache

# Performance stats
GET /health/performance

Métricas Disponíveis

Cache: Hit rate, estatísticas Redis
Performance: Tempo de resposta, queries lentas
Sistema: CPU, memória, uptime
Tasks: Queue status, workers ativos

🧪 Testes

Executar Testes

# Todos os testes
pnpm test

# Testes unitários
pnpm test:unit

# Testes e2e
pnpm test:e2e

# Cobertura
pnpm test:cov

# Watch mode
pnpm test:watch

Estrutura de Testes

test/
├── unit/           # Testes unitários
├── integration/    # Testes de integração
└── e2e/           # Testes end-to-end

📚 Documentação da API

Swagger/OpenAPI

Acesse a documentação interativa:

http://localhost:3000/docs

Postman Collection

Importe a collection disponível em /docs/postman/

Exemplos de Uso

Criar Usuário

curl -X POST http://localhost:3000/api/v1/users \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "name": "John Doe"}'

Buscar Usuário

curl http://localhost:3000/api/v1/users/{id}

🐳 Docker

Docker Compose (Desenvolvimento)

# docker-compose.yml incluído
services:
  - postgres
  - redis
  - adminer (opcional)

# Subir todos os serviços
docker-compose up -d

# Apenas banco e cache
docker-compose up -d postgres redis

Dockerfile (Produção)

# Build da imagem
docker build -t storagie-backend .

# Executar container
docker run -p 3000:3000 storagie-backend

🚀 Deploy

Variáveis Obrigatórias em Produção

APP_ENV=production
COOKIE_SECRET=your-secure-secret
JWT_SECRET=your-secure-secret
JWT_REFRESH_SECRET=your-secure-secret
DB_HOST=your-production-db
DB_PASSWORD=your-secure-password
REDIS_HOST=your-redis-host

Plataformas Suportadas

Heroku - Deploy direto
AWS ECS/Fargate - Containerizado
Google Cloud Run - Serverless
Railway - Deploy simplificado
DigitalOcean App Platform - PaaS

Checklist de Deploy

🤝 Contribuindo

Workflow

Fork o projeto
Clone seu fork
Crie uma branch (git checkout -b feature/nova-feature)
Faça suas alterações
Teste tudo (pnpm test)
Commit (git commit -m 'feat: nova feature')
Push (git push origin feature/nova-feature)
Abra um Pull Request

Padrões

Commits: Use Conventional Commits
Code Style: ESLint + Prettier configurados
Testes: Mantenha cobertura > 80%
Documentação: Atualize docs relevantes

Estrutura de Commits

feat: nova funcionalidade
fix: correção de bug
docs: atualização de documentação
style: formatação de código
refactor: refatoração
test: adição de testes
chore: tarefas de manutenção

📄 Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

🆘 Suporte

Documentação: ARCHITECTURE.md | CONFIGURATION.md
Issues: Reporte bugs ou sugira melhorias
Discussions: Participe das discussões da comunidade

Feito com ❤️ usando NestJS, TypeScript e Clean Architecture

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
src		src
test		test
.env.example		.env.example
.gitignore		.gitignore
.node-version		.node-version
.prettierrc		.prettierrc
.swcrc		.swcrc
ARCHITECTURE.md		ARCHITECTURE.md
CONFIGURATION.md		CONFIGURATION.md
README.md		README.md
data-source.ts		data-source.ts
docker-compose.yml		docker-compose.yml
eslint.config.mjs		eslint.config.mjs
nest-cli.json		nest-cli.json
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.build.json		tsconfig.build.json
tsconfig.json		tsconfig.json

gilstack/nestjs-ddd

Folders and files

Latest commit

History

Repository files navigation

🚀 Storagie Backend

📋 Índice

🎯 Sobre o Projeto

🛠️ Tecnologias

Core Framework

Banco de Dados & ORM

Cache & Performance

Segurança & Validação

Monitoramento & Logs

DevOps & Qualidade

🏗️ Arquitetura

🚀 Início Rápido

Pré-requisitos

⚡ Quick Start

📦 Instalação

Usando pnpm (Recomendado)

Usando npm

Usando yarn

⚙️ Configuração

1. Variáveis de Ambiente

2. Configurações Essenciais

3. Banco de Dados

🏃‍♂️ Executando

Desenvolvimento

Produção

Com Docker

🔍 Scripts Disponíveis

Desenvolvimento

Banco de Dados

Qualidade de Código

Docker

📊 Monitoramento

Health Checks

Métricas Disponíveis

🧪 Testes

Executar Testes

Estrutura de Testes

📚 Documentação da API

Swagger/OpenAPI

Postman Collection

Exemplos de Uso

Criar Usuário

Buscar Usuário

🐳 Docker

Docker Compose (Desenvolvimento)

Dockerfile (Produção)

🚀 Deploy

Variáveis Obrigatórias em Produção

Plataformas Suportadas

Checklist de Deploy

🤝 Contribuindo

Workflow

Padrões

Estrutura de Commits

📄 Licença

🆘 Suporte

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages