Skip to content

renanrudney/survey_api-clean-code-node

Repository files navigation

Build Status Coverage Status js-standard-style

Survey Clean Node API

Study Case: Node with Typescript, TDD, DDD, Clean Architecture and SOLID.

  • Works with GraphQL

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the 12.x version of NodeJS
  • You have a mongodb instance

Installing Project

To install dependencies, run:

npm install

Using Project

To use, follow these steps:

npm run build:watch
npm run debug

Or run tests:

npm test

Principles

  • Single Responsibility Principle (SRP)
  • Open Closed Principle (OCP)
  • Liskov Substitution Principle (LSP)
  • Interface Segregation Principle (ISP)
  • Dependency Inversion Principle (DIP)
  • Separation of Concerns (SOC)
  • Don't Repeat Yourself (DRY)
  • You Aren't Gonna Need It (YAGNI)
  • Keep It Simple, Silly (KISS)
  • Composition Over Inheritance
  • Small Commits

Methodology and Design

  • TDD
  • Clean Architecture
  • DDD
  • Conventional Commits
  • GitFlow
  • Modular Design
  • Dependency Diagrams
  • Use Cases
  • Continuous Integration
  • Continuous Delivery
  • Continuous Deployment