How kokeitor/node-express-ts-public works
Project type and purpose
• This is a backend RESTful API service built with Node.js, Express and TypeScript, structured according to Clean Architecture.
• Its primary responsibilities are user authentication (JWT + role-based access), user CRUD operations against a PostgreSQL database, email-verification via the Resend service, and professional logging/monitoring via Better Stack.
File structure
• Top-level directories:
• src/presentation – HTTP layer: Express app entrypoint, routers, controllers, middleware.
• src/domain – Pure business logic: entities, DTOs, use-cases, repository interfaces, error definitions.
• src/infrastructure – Implementation of domain interfaces: data sources, mappers, repository concrete classes.
• src/adapters – Third-party integrations: bcrypt, JWT, Resend email client.
• src/config – Environment, database connection (PostgreSQL), logging (Winston), validation (Zod).
• data – Static assets: SQL scripts, email templates.
• tests – Supertest/Jest test suites for API, auth, CRUD and health checks.
• Configuration and deployment files:
• .github/workflows/deploy-pipeline.yaml – CI/CD pipeline.
• example.env/.secrets/ca.pem – Environment and DB certificates.
• tsconfig.json, eslint.config.mjs – TypeScript and lint settings.
README for additional insights
• Confirms Clean Architecture and modular patterns (ports & adapters).
• Lists key features: JWT authentication middleware, role validation, user CRUD, email verification.
• Mentions technology stack: Node.js, Express.js, TypeScript, PostgreSQL on Aiven Cloud, Better Stack logging, GitHub Actions CI/CD.
• Testing strategy: Jest + Supertest, parallelized tests, lint & transpile.
Detail level
• Critical modules: routes, controllers, use-cases, repositories, data sources, adapters
• Do not collapse the domain layer—show individual use-cases and repository interfaces
• Config/environment as a side component that feeds into app initialization
• Test suite in a separate lane to show coverage of routes and use-cases