{"id":32182275,"url":"https://github.com/hhsadiq/NestForge","last_synced_at":"2025-10-21T23:02:35.369Z","repository":{"id":312837516,"uuid":"1048877205","full_name":"hhsadiq/NestForge","owner":"hhsadiq","description":"NestForge is a modern NestJS boilerplate that jump-starts your backend development. It comes with AI-powered CRUD generators, auth (JWT \u0026 sessions), file uploads, and other common modules built-in, so you can focus on your business logic instead of reinventing the wheel.","archived":false,"fork":false,"pushed_at":"2025-10-15T10:02:32.000Z","size":17330,"stargazers_count":7,"open_issues_count":6,"forks_count":1,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2025-10-15T20:57:01.753Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hhsadiq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-02T06:52:05.000Z","updated_at":"2025-10-15T12:51:37.000Z","dependencies_parsed_at":"2025-09-02T10:29:18.308Z","dependency_job_id":"c5eb7b4c-84ed-45d4-bfc5-7674c8136b34","html_url":"https://github.com/hhsadiq/NestForge","commit_stats":null,"previous_names":["hhsadiq/nestforge"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hhsadiq/NestForge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hhsadiq%2FNestForge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hhsadiq%2FNestForge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hhsadiq%2FNestForge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hhsadiq%2FNestForge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hhsadiq","download_url":"https://codeload.github.com/hhsadiq/NestForge/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hhsadiq%2FNestForge/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280348062,"owners_count":26315368,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-21T02:00:06.614Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-21T23:00:50.321Z","updated_at":"2025-10-21T23:02:35.359Z","avatar_url":"https://github.com/hhsadiq.png","language":"TypeScript","funding_links":[],"categories":["🚀 Boilerplates \u0026 Starters"],"sub_categories":[],"readme":"# 🚀 NestForge\n\n\u003cdiv align=\"center\"\u003e\n\n![NestForge Logo](https://img.shields.io/badge/NestForge-v1.2.0-blue?style=for-the-badge\u0026logo=nestjs)\n\n**A Complete AI-Powered NestJS Boilerplate with Hexagonal Architecture**\n\n[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat-square\u0026logo=typescript\u0026logoColor=white)](https://www.typescriptlang.org/)\n[![NestJS](https://img.shields.io/badge/NestJS-E0234E?style=flat-square\u0026logo=nestjs\u0026logoColor=white)](https://nestjs.com/)\n[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-316192?style=flat-square\u0026logo=postgresql\u0026logoColor=white)](https://www.postgresql.org/)\n[![Docker](https://img.shields.io/badge/Docker-2496ED?style=flat-square\u0026logo=docker\u0026logoColor=white)](https://www.docker.com/)\n[![License](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE)\n\n_Built with enterprise-grade architecture patterns and automated code generation_\n\n\u003c/div\u003e\n\n---\n\n## 🎬 Platform Overview\n\n\u003cdiv align=\"center\"\u003e\n\n**🚀 NestForge - Complete Platform Walkthrough**\n\nExperience the full power of NestForge from setup to code generation to AI-assisted development\n\nhttps://github.com/user-attachments/assets/8db02e0b-f3a0-475d-a535-01ed7068cbe0\n\n\u003c/div\u003e\n\n---\n\n## 🎥 How to Use NestForge\n\n\u003cdiv align=\"center\"\u003e\n\n**🧭 Practical Demo – From Setup to Final Result**\n\nWatch a demonstration on how to use NestForge to quickly generate outcomes.\n\nhttps://github.com/user-attachments/assets/5cc4b4a7-a962-4e8b-b364-9a95b185ea3f\n\n\u003c/div\u003e\n\n---\n\n## 🎯 What is NestForge?\n\nNestForge is more than a boilerplate — it's a **complete AI-powered development platform** that takes you from database schema to production-ready API in minutes.\n\n### 🚀 Why It Stands Out\n\nUnlike traditional boilerplates, NestForge doesn’t just give you a starting point — it uses **AI-assistance generators** to create **production-ready CRUD modules** for your custom projects and then guides you in extending them with business logic while keeping your code fully aligned with architectural standards.\n\n### ⚡ Core Capabilities\n\n- ⚡ **Zero-Config Setup** – Spin up a full API instantly\n- 🏗️ **Hexagonal Architecture** – Clean, maintainable, testable\n- 📦 **Enterprise Features** – JWT, Biometric login, Social Auth, File Management, Mailing System, i18n, GitHub Actions\n- 🎯 **Hygen Code Generation** – Create modules from JSON/SQL in seconds\n- 🤖 **AI that codes with you** – automates setup, validates code, and helps you add business logic that stays perfectly aligned with your architecture.\n- 🧪 **Full Testing Suite** – Unit, E2E, and Load tests ready-to-run\n\n**AI + automation handle the busywork, letting you focus on real business logic.**\n\n## ✨ Key Features\n\n### 🏛️ **Hexagonal Architecture**\n\nClean separation of business logic from infrastructure concerns with consistent module structure and absolute path imports for cleaner project organization.\n\n### 🗄️ **Database \u0026 ORM**\n\nTypeORM with PostgreSQL integration, comprehensive seeding system, read replica support for improved performance, and example database views for better query abstraction and reporting.\n\n### ⚡ **Caching \u0026 Performance**\n\nRedis-powered caching system with cluster support, automatic TLS configuration, and comprehensive cache management for improved application performance and scalability.\n\n### 🤖 **Automated Code Generation (Hygen)**\n\nGenerate entire modules from JSON schemas or SQL with batch and interactive generators. Includes template automation, resource generation, versioning, property management, and raw query handling.\n\n### 🤖 **AI-Powered Development with Cursor**\n\nComprehensive `.cursorrules` configuration that trains Cursor AI to understand hexagonal architecture patterns, Hygen generator commands, JSON schema validation, and architecture enforcement for domain-aware development assistance.\n\n### 🚀 **One-Command Setup**\n\nComplete project initialization from clone to running server with automated configuration and environment setup.\n\n### 🔐 **Authentication \u0026 Security**\n\n- JWT authentication, social login (Apple, Google, Facebook, Twitter),\n- `Biometric` Feature with challenge-based authentication and server-side validation using cryptographic signing.\n\n### 📁 **File Management**\n\nMulti-driver support (Local, S3, S3-Presigned URLs) with automatic optimization and secure upload validation.\n\n### 🌐 **Internationalization**\n\nMulti-language support with dynamic translations and localized error messages using nestjs-i18n.\n\n### 📧 **Mailing System**\n\nComprehensive email system with nodemailer integration for transactional emails and notifications.\n\n### 📚 **API Documentation**\n\nSwagger API documentation with automatic generation and comprehensive endpoint coverage.\n\n### 🧪 **Comprehensive Testing**\n\nUnit tests (Jest), E2E tests (Dockerized), and load testing (Artillery) with automated seeding and performance benchmarking.\n\n### 🐳 **DevOps \u0026 Docker**\n\nDocker support, containerization, and development environment management with comprehensive Docker Compose configurations.\n\n### 🚀 **Production \u0026 CI/CD**\n\nCI/CD workflows with GitHub Actions, database management, and Sentry monitoring integration for production deployments.\n\n## 🛠️ Build Custom Projects\n\nNestForge isn't just a boilerplate—it's a complete development platform that empowers you to build custom features with minimal effort. Here's how our features work together to accelerate your development:\n\n### 🎯 **The Custom Development Workflow**\n\n**Step 1: Database Design** → **Step 2: Code Generation** → **Step 3: AI-Assisted Development**\n\n1. **Create Migration File** - Define your database schema using TypeORM migrations\n   - 🤖 **[NestForge Schema Architect](https://chatgpt.com/g/g-68c7c2d593348191beb9ffa8db839f2f-nestforge-schema-architect)** - This custom GPTs will help you generate complete database schemas from your requirements in 3 simple steps (Requirements → Overview → SQL)\n2. **Generate JSON Schema** - Convert your SQL schema to Hygen-compatible JSON using our AI-powered prompts\n   - 🤖 **[NestForge SQL to JSON](https://chatgpt.com/g/g-68c93a7fdb0c819184b9eb4cb038b866-nestforge-sql-to-json)** - This custom GPTs will help you generate NestForge-compatible JSON files from your PostgreSQL SQL schemas for seamless code generation\n3. **Run Hygen Commands** - Generate complete modules with tests, DTOs, services, controllers, and repositories\n4. **AI-Enhanced Development** - Use Cursor AI with our comprehensive `.cursorrules` training material\n\n### 🤖 **AI-Powered Development with Cursor**\n\nNestForge includes extensive `.cursorrules` configuration that trains Cursor AI to understand:\n\n- **Hexagonal Architecture Patterns** - AI knows the exact module structure and boundaries\n- **Hygen Generator Commands** - AI can run the correct generators automatically\n- **JSON Schema Validation** - AI validates and generates proper entity schemas\n- **Architecture Enforcement** - AI ensures services don't import persistence entities\n- **Type Safety** - AI enforces strict TypeScript patterns throughout\n\n**Result:** Cursor becomes your domain-aware development assistant, not just a generic code generator.\n\n### 🚀 **What You Get**\n\n- **Complete Modules** - Full CRUD operations with validation, error handling, and tests\n- **Consistent Architecture** - Every generated module follows hexagonal patterns\n- **Type Safety** - Full TypeScript support with explicit types (no `any`)\n- **Testing Suite** - Unit tests, E2E tests, and load tests automatically generated\n- **Documentation** - Swagger endpoints and comprehensive API documentation\n- **Production Ready** - Docker support, CI/CD workflows, and monitoring integration\n\n### 💡 **Example: Building a Product Catalog**\n\n1. **Migration**: Create `product` and `category` tables\n2. **JSON Schema**: Generate entity definitions with relationships\n3. **Single Script**: Run `npm run setup`.\n4. **Result**: Complete product management system with:\n   - Product \u0026 Category entities with relationships\n   - Full CRUD APIs with validation\n   - Unit tests\n   - Swagger documentation\n   - Type-safe DTOs and services.\n   - **Swagger Documentation**: `\u003chttp://localhost:3000/docs\u003e`\n   - Credentials for user:\n     - **Email**: `admin@example.com`\n     - **Password**: `secret`\n\n**Time to Production**: From database design to working API in minutes, not hours.\n\n## 🚀 Quick Start\n\nGet NestForge running in minutes with our automated setup script. Clone the repository and run `npm run setup` for complete initialization from database setup to running server.\n\n📖 **[Installation Guide](docs/installing-and-running.md)** - Manual setup and troubleshooting\n\n## ⚙️ Automated Setup\n\nNestForge includes a powerful automated setup script that handles everything from environment configuration to database initialization and server startup. Perfect for quick project initialization and consistent development environments.\n\n📖 **[Setup Script Guide](docs/setup-script.md)** - Complete automated setup documentation\n\n## 🏗️ Architecture Overview\n\nNestForge implements **Hexagonal Architecture** (Ports \u0026 Adapters) with clean separation between business logic and infrastructure concerns. Each module follows a consistent structure ensuring maintainability and testability.\n\n📖 **[Complete Architecture Guide](docs/architecture.md)** - Deep dive into hexagonal patterns, module structure, and architectural principles\n\n## 🤖 Code Generation\n\nNestForge provides powerful code generation capabilities through Hygen generators. Create entire modules from JSON schemas, SQL statements, or interactive prompts with support for entities, relationships, and enums.\n\n### 📚 **Documentation \u0026 Guides**\n\n📖 **[Complete Hygen Documentation](docs/hygen/index.md)** - All generators, JSON schemas, and usage examples\n📖 **[SQL to JSON Conversion](docs/hygen/sql-to-json-entities-prompt.md)** - Convert SQL schemas to NestJS modules\n\n## 🧪 Testing\n\nComprehensive testing suite with unit tests (Jest), E2E tests (Dockerized), and load testing (Artillery). All tests include automated seeding and detailed reporting for complete application validation.\n\n📖 **[Complete Testing Guide](docs/tests.md)** - Unit, E2E, and Docker testing\n📖 **[Load Testing Guide](docs/artillery.md)** - Performance benchmarking with Artillery\n\n## 📚 Documentation\n\nComplete documentation covering architecture, development workflows, and production deployment. Each feature has dedicated guides with examples and best practices.\n\n📖 **[Full Documentation Index](docs/readme.md)** - Comprehensive guide with table of contents\n\n## 🌟 What Makes NestForge Special?\n\n### 🎯 **Developer Experience**\n\n- **Zero Decision Fatigue**: Pre-configured architecture and patterns\n- **AI-Assisted Development**: Smart code generation and Cursor AI integration\n- **Comprehensive Documentation**: Every feature thoroughly documented\n- **Hot Reload**: Instant feedback during development\n\n### 🏢 **Enterprise Ready**\n\n- **Scalable Architecture**: Hexagonal patterns for large applications\n- **Security First**: Industry-standard authentication and authorization\n- **Production Monitoring**: Sentry integration and error tracking\n- **CI/CD Pipeline**: Automated testing and deployment\n\n### 🔄 **Maintainable Codebase**\n\n- **Consistent Structure**: Enforced patterns across all modules\n- **Type Safety**: Full TypeScript support with strict typing\n- **Clean Code**: ESLint, Prettier, and architectural guidelines\n- **Version Management**: Automated dependency updates\n\n---\n\n## 🤝 Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CODE_OF_CONDUCT.md) for details.\n\n### Development Workflow\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Add tests for new functionality\n5. Ensure all tests pass\n6. Submit a pull request\n\n---\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n## 🙏 Acknowledgments\n\n- **[NestJS Team](https://nestjs.com/)** for the amazing framework\n- **[TypeORM](https://typeorm.io/)** for excellent database integration\n- **[Hygen](https://github.com/jondot/hygen)** for powerful code generation\n- **[Cursor AI](https://cursor.com)** for AI-powered development assistance\n- **[Cursor Commands](https://github.com/hamzafer/cursor-commands)** for cursor commands\n- **Community Contributors** for feedback and improvements\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**⭐ Star this repository if you find it helpful!**\n\n[![GitHub stars](https://img.shields.io/github/stars/hhsadiq/NestForge?style=social)](https://github.com/hhsadiq/NestForge)\n[![GitHub forks](https://img.shields.io/github/forks/hhsadiq/NestForge?style=social)](https://github.com/hhsadiq/NestForge)\n\n**Built with ❤️ by the NestForge Team**\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhhsadiq%2FNestForge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhhsadiq%2FNestForge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhhsadiq%2FNestForge/lists"}