The ssam-d-node from hye-on

ssam-d-node's Introduction

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Installation

$ pnpm install

Running the app

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

Docker Setting

# Local ELK Setting Init
$ docker buildx build -t ssamd-elasticsearch-with-nori -f Dockerfile.es-nori .

# Local ELK Run
$ docker-compose up --build

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

API Spec Example

Tspec 공식문서

import { Tspec } from 'tspec';

export type AuthorApiSpec = Tspec.DefineApiSpec<{
  basePath: '/keywords'; // 기본 경로
  tags: ['Keyword']; // 스웨거 태깅
  paths: {
    '/': {
      get: {
        summary: 'API 요약 - get';
        responses: {
          200: UserResDto;
        };
      };
      post: {
        summary: 'API 요약 - post';
        requestBody: UserReqDto;
        responses: {
          201: UserResDto;
        };
      };
    };
    '/{id}': {
      patch: {
        summary: 'API 요약 - patch';
        path: { id: number };
        requestBody: UserReqDto;
        responses: {
          200: UserResDto;
        };
      };
      delete: {
        summary: 'API 요약 - delete';
        path: { id: number };
        responses: {
          204: void;
        };
      };
    };
  };
}>;

Recommend Projects