Post Service

Overview

A robust microservice for post management, built with NestJS, providing comprehensive content creation, retrieval, and management capabilities.

Key Features

• CRUD operations for posts
• Advanced filtering and search
• Pagination support
• Content validation
• Event-driven architecture
• Comprehensive error handling
• Scalable design

Technology Stack

• NestJS
• Prisma ORM
• PostgreSQL
• KafkaJS
• Sentry for error tracking
• Swagger for API documentation

Getting Started

Prerequisites

• Node.js 18+
• Yarn
• PostgreSQL
• Kafka

Installation

# Install dependencies
$ yarn install

# Generate Prisma client
$ yarn prisma:generate

# Run database migrations
$ yarn prisma:migrate

Running the Service

# Development mode
$ yarn dev

# Production mode
$ yarn start

Database Management

# Generate Prisma schema
$ yarn prisma:generate

# Run database migrations (development)
$ yarn prisma:migrate

# Run database migrations (production)
$ yarn prisma:migrate-prod

# Open Prisma Studio
$ yarn prisma:studio

Testing

# Run unit tests
$ yarn test

# Run end-to-end tests
$ yarn test:e2e

# Generate test coverage report
$ yarn test:cov

Configuration

Configuration is managed through environment variables and NestJS ConfigModule.

Key configurations:

• Database connection
• Kafka settings
• Sentry error tracking

Monitoring and Observability

• Sentry error tracking
• Swagger API documentation
• Health check endpoints
• Logging

Development Workflow

1. Fork the repository
2. Create a feature branch
3. Implement changes
4. Write tests
5. Run linting and formatting
6. Submit a pull request