TEN 스택: Typescript-Express-Node 템플릿(2022년 업데이트됨)

개요

TEN 스택은 Typescript 서버 앱을 개발하기 위한 Express + Node + REST API 스타터 키트입니다.
태양 아래 새로운 것은 없으며, 서버 개발을 조금 더 빠르게 만드는 간단한 콤보입니다. 이 템플릿은 Node.js 기반의 서버 측 세계에서 시작하는 모든 사용자에게 적합합니다.

이 템플릿은 다음과 함께 제공됩니다.

DI 및 DAO(확장 가능)가 포함된 클래스 기반 OOP 아키텍처

TDD 장착 Jest

Typescript으로 엄격하게 입력된 모든 항목

ES6 기능/모듈

ES7 async/await

템플릿이 있는 전역 오류 처리 아키텍처(ApiError, TimeOutError, ValidationError 등)

Express-validator을 사용하여 사용자 지정 미들웨어로 유효성 검사 요청

Express-Pinno-Logger을 사용한 매우 빠른 로깅

Nodemon과 함께 실행하여 자동 재장전 및 감시

ESLint 코드 린팅용

Prettier을 사용한 코드 서식 지정

dotenv을 사용한 구성 관리

Husky (v8) - 사전 커밋 및 사전 푸시로 개선된 커밋

PM2을 사용하여 프로덕션 앱 프로세스 관리

Github Actions이 포함된 CI/CD 워크플로

편집 가능한 Github 풀 리퀘스트 및 이슈 템플릿

전제 조건

Node.js ( >= 16.x )

Yarn 또는 NPM

설치

포크 또는 사용this 템플릿 저장소.

Clone 포크된 저장소.

yarn 또는 npm을 사용하여 종속성을 설치합니다.

Make sure you already have node.js and npm or yarn installed in your system.

git remote add origin 경로 설정

 git remote add origin ${forked-and-cloned-path}

Update the url if you already have an origin

구성

응용 프로그램의 루트에 파일을 복사합니다.env.example.

특정 변수를 추가 또는 수정하고 필요에 따라 업데이트합니다.

 cp .env.example .env

Check the config folder to customize your settings (/src/config)

별칭@

경로를 깨끗하고 접근하기 쉽게 만들기 위해 @는 /src 경로에 대해 설정됩니다.

// BEFORE
import config from './config';
import routes from './routes';

// NOW
import config from '@/config';
import routes from '@/routes';

You can customize this setup:
/tsconfig.json > compilerOptions.baseUrl & compilerOptions.paths

지역 개발

서버를 로컬로 실행합니다. Nodemon과 함께 실행되고 포트8080에서 제공할 준비가 됩니다(.env에서 지정하지 않는 한)

 yarn start # or npm start

Check package.json to see more "scripts"

지속적 통합 및 지속적 배포(CI/CD)

워크플로는 .github 폴더 아래에 있습니다.
모든 PR 업데이트에서 CI가 트리거됩니다.
지정된 분기가 푸시되면 CD가 트리거됩니다(예: main , develop )

설정에 대한 자세한 정보가 필요한 경우 this 문서를 확인하십시오.

생산

먼저 애플리케이션을 빌드합니다.

 yarn build # or npm run build

그런 다음 pm2 을 사용하여 응용 프로그램을 서비스로 시작합니다.

 yarn service:start # or npm run service:start

기부금

소스 확인hereissue 또는 pull request를 열어 변경 사항이나 추가 사항을 제안하십시오.