bishopsmove / node-clean-architecture

A Node template that follows the Clean Architecture principles and encourages established practices.

Clean Architecture Template

A Node template that follows the Clean Architecture principles and encourages established practices.

Features

• TypeScript first
• Dependency injection via Awilix
• CQRS (Command Query Responsibility Segregation)
• High test coverage (unit, integration and functional tests)
• Automatic error handling
• Logging
• Versioned APIs
• Swagger
• Prisma ORM

Getting Started

1. Install the latest Node.js LTS
2. Install Docker and ensure that it is running
3. Create .env file cp .env.example .env
4. Install project dependencies by running yarn install
5. Start Docker (local Postgres instance) docker-compose up -d
6. Create database npx prisma migrate deploy
7. Start development server yarn start
8. Navigate to Swagger ( http://localhost:3000/api-docs)

Scripts

Build production bundle

yarn build

Lint project (eslint)

yarn lint

Start development server

yarn start

Run all tests

yarn test

Run unit tests

yarn test:unit

Run functional tests (API tests)

yarn test:functional