steedos-builder6-architecture

Explain Builder6 Server architecture, including NestJS and Moleculer hybrid modules and middleware.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-builder6-architecture
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: steedos-builder6-architecture
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-builder6-architecture
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-builder6-architecture

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Understand Builder6 Server architecture and how its NestJS + Moleculer hybrid monorepo is organized.

Core Features & Use Cases

  • Architecture overview of the Builder6 server, including module organization (AppModule.forRoot), bootstrap sequence, and middleware stack.
  • Runtime details covering Redis-backed sessions, cookie parsing, compression, CORS, and Socket.IO hybrid WebSocket integration.
  • Developer references to Swagger/OpenAPI at /api/v6, guards (AuthGuard, AdminGuard), and Nx/Lerna workspace patterns.

Quick Start

Review the architecture overview to onboard new engineers and plan backend enhancements.

Frequently Asked Questions about steedos-builder6-architecture

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How does the NestJS and Moleculer hybrid architecture organize a backend monorepo?

A NestJS and Moleculer hybrid monorepo uses AppModule.forRoot to structure 20+ packages within an Nx/Lerna workspace. This architecture defines module organization, bootstrap sequences, and middleware stacks for backend services.

How is WebSocket integration handled in a NestJS Moleculer server?

WebSocket integration in a NestJS Moleculer server is handled through the Socket.IO HybridAdapter. This setup enables real-time communication alongside the main HTTP bootstrap sequence and middleware stack.

What middleware and runtime configurations does a NestJS monorepo use for session management?

NestJS monorepo runtime configuration uses Redis-backed sessions, cookie parsing, compression, and CORS middleware. These components are initialized during the bootstrap sequence to manage authentication and request handling.

How do I access API documentation in a NestJS Moleculer backend?

You access API documentation in a NestJS Moleculer backend via Swagger and OpenAPI specifications hosted at the /api/v6 endpoint. This provides interactive reference for all available REST API routes.

Can I use AuthGuard and AdminGuard for route protection in a NestJS monorepo?

Yes, you can use AuthGuard and AdminGuard for route protection in a NestJS monorepo. These guards enforce authentication and authorization rules during the middleware stack execution before reaching controllers.

What are the standard development commands for building a NestJS Lerna workspace?

Standard development commands for a NestJS Lerna workspace include start:dev for local runtime, build for compilation, and lint for code quality. These commands orchestrate the 20+ packages within the monorepo.