go-meow

A comprehensive microservice template and utility library built with TypeScript, Express, and Prisma (MongoDB). This package provides both reusable utilities for existing projects and a complete scaffolding system for creating new microservices.

🎯 What's Included

📦 Reusable Utilities

• Query utilities with flexible response formats (documents, pagination, count)
• Data grouping functionality for organizing API responses
• Validation helpers with Zod integration
• Logging utilities (activity & audit logging)
• Security middleware (rate limiting, authentication, authorization)
• Form data helpers for multipart uploads
• Error handling utilities

🏗️ Service Scaffolding

• Template-based service generation
• Prisma schema generation with MongoDB support
• Zod validation schema generation
• Test suite generation with 65+ test cases
• Database seeder generation with realistic test data
• OpenAPI/Swagger documentation generation

📋 Installation

npm i go-meow

🚀 Quick Start

Using the CLI Tools

# Generate a new service
npx go-meow-generate user

# Copy and customize existing service
npx go-meow-copy --from template --to orders

# Export OpenAPI documentation
npx go-meow-docs

🔧 API Reference

Query Utilities

The package provides flexible query utilities that support multiple response formats:

Service Generation

Generate New Service

npx go-meow-generate <serviceName>

This creates:

• Controller with CRUD operations
• Router with all endpoints
• Prisma schema
• Zod validation schemas
• Test suite (65+ test cases)
• Database seeder with realistic data
• OpenAPI documentation

Copy Existing Service

npx go-meow-copy --from <source> --to <target>

This copies and renames an existing service, updating all references.

🧪 Testing

The generated services include comprehensive test suites with:

• 65+ test cases covering all functionality
• CRUD operations testing
• Data grouping functionality tests
• Query parameter validation tests
• Form data handling tests
• Error scenario testing
• Edge case coverage

npm test  # Run all tests

📚 Documentation

Generated Documentation

Each generated service includes:

• OpenAPI/Swagger documentation
• Postman collection
• Endpoint documentation (JSON format)

CLI Commands

# List all available endpoints
npm run api-list

# Export documentation
npm run export-docs

# Generate OpenAPI specs
npx msa-docs

📄 License

This project is licensed under the ISC License.

🏷️ Keywords

typescript, express, prisma, mongodb, microservice, template, scaffolding, api, rest, swagger, openapi, zod, validation, logging, security, middleware, query-utils