KIME API

Scalable, typed and monitored NestJS API with PostgreSQL, CI/CD, testing, and observability.

---

🚀 Features

• ✅ Fully-typed REST API built with NestJS
• 🐘 PostgreSQL container via Docker
• ⚙️ GitHub Actions for CI/CD
• 🧪 Unit, E2E & mutation testing (Jest + Stryker)
• 📊 Code coverage via Codecov
• 🔬 Code quality enforcement via SonarCloud
• 📦 Commit hooks with Lefthook, Commitlint, and Biome
• 🧠 Error tracking and profiling with Sentry
• 📚 Swagger documentation at /docs/

---

📦 Getting Started

Clone and setup

git clone https://github.com/garatortiz/kime-api.git
cd kime-api
cp .env.example .env
npm install

Run DB with Docker

docker compose up -d

This will start PostgreSQL 15 with user kime_user, password kime_password, and DB kime_db

Run in development mode

npm run start:dev

---

🧪 Testing

# Run all unit and e2e tests
npm test

# Run E2E only
npm run test:e2e

# Watch mode
npm run test:watch

# Coverage
npm run test:cov

# Mutation testing (Stryker)
npm run test:mutation

---

🛠️ Tooling & Quality

# Run linter
npm run lint

# Format with Biome
npm run format

# Type check
npm run typecheck

Commit hooks are managed via Lefthook, using Commitlint + Biome.

---

📜 API Documentation

Once the app is running, Swagger docs are available at:

👉 http://localhost:3000/docs/

Includes examples for each endpoint and automatic linking between operations.

---

📊 Observability (Sentry)

This project is instrumented with @sentry/nestjs + @sentry/profiling-node.

To enable Sentry:

1. Create a project in Sentry.io
2. Add your DSN in .env:

SENTRY_DSN=https://your_dsn@o12345.ingest.sentry.io/projectid

3. Sourcemaps are uploaded via:

npm run build

This runs sentry-cli sourcemaps inject + upload on your /dist folder.

---

🌐 Deployment

Vercel or any Node-compatible host works. Example:

vercel --prod

Or deploy using Docker:

docker build -t kime-api .
docker run -p 3000:3000 --env-file .env kime-api

---

📁 Project Structure

├── src/
│   ├── main.ts             # Entry point
│   ├── instrument.ts       # Sentry instrumentation
│   ├── users/              # Users module
│   ├── auth/               # Auth module
│   └── filters/            # Global exception filter
├── test/                   # E2E and unit tests
├── Dockerfile
├── docker-compose.yml
└── ...

---

🤝 Contributing

PRs welcome! Please follow the conventional commit spec (npm run commit) and make sure all checks pass locally:

npm run lint && npm test && npm run typecheck && npm run format

---

🪪 License

MIT © Matías Garat Ortiz