backend-dev-guidelines

Codify layered architecture for Node.js/Express TypeScript backend projects.

4|1|Updated Apr 4, 2024

Search Tags:#typescript #architecture #backend #patterns #guidelines #nodejs

Ready to run

npx skills add https://github.com/maraxen/praxis --skill backend-dev-guidelines-maraxen

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: backend-dev-guidelines
Source: https://github.com/maraxen/praxis/tree/main/.agent/skills/backend-dev-guidelines
Command: npx skills add https://github.com/maraxen/praxis --skill backend-dev-guidelines-maraxen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishes a consistent, scalable backend development approach by codifying architecture, patterns, and best practices across Node.js/Express/TypeScript services.

Core Features & Use Cases

Layered architecture guidance: routes, controllers, services, repositories separation.
Component conventions: directory structure, naming, and reusable patterns like BaseController, validation, error handling.
Observability and quality: Sentry integration, testing strategies, and migration playbooks to reduce regressions.

Quick Start

Start by auditing an existing project against these guidelines and begin refactoring routes, controllers, and services to align with the prescribed architecture.

Frequently Asked Questions about backend-dev-guidelines

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

FAQPage Schema

How do I structure a Node.js Express TypeScript backend for scalability?▼

Structure it using a layered architecture that separates routes, controllers, services, and repositories. This approach codifies clear responsibilities across Node.js Express TypeScript projects, establishing a consistent and scalable backend development approach.

What is the recommended directory layout for a Node.js TypeScript service?▼

The recommended directory layout enforces a structured organization for Node.js TypeScript services. It requires specific component conventions, including a shared BaseController, to maintain naming consistency and reusable patterns across the project.

How do I integrate Sentry error handling into an Express TypeScript application?▼

Integrate Sentry error handling into Express TypeScript applications by applying integrated error handling patterns within your controllers and middleware. This provides robust observability tooling and reduces regressions across your backend services.

How do I refactor existing Node.js routes and controllers to follow backend patterns?▼

Refactor existing Node.js routes and controllers by auditing your project against established guidelines. Begin aligning routes, controllers, and services with the prescribed layered architecture to resolve architectural inconsistency.

Can I use these backend guidelines for an existing Express project with inconsistent patterns?▼

Yes, you can use these backend guidelines for existing Express projects with inconsistent patterns. The guidelines provide migration playbooks and testing strategies specifically designed to reduce regressions while refactoring.