TypeScript Express Starter

🚀 TypeScript 기반 Express RESTful API 보일러플레이트

<a href="http://npm.im/typescript-express-starter" target="_blank">
  <img src="https://img.shields.io/npm/v/typescript-express-starter.svg" alt="npm 버전" />
</a>
<a href="http://npm.im/typescript-express-starter" target="_blank">
  <img src="https://img.shields.io/github/v/release/ljlm0402/typescript-express-starter" alt="GitHub 릴리즈 버전" />
</a>
<a href="http://npm.im/typescript-express-starter" target="_blank">
  <img src="https://img.shields.io/npm/dm/typescript-express-starter.svg" alt="npm 다운로드 수" />
</a>
<a href="http://npm.im/typescript-express-starter" target="_blank">
  <img src="https://img.shields.io/npm/l/typescript-express-starter.svg" alt="라이선스" />
</a>

• 🇰🇷 한국어
• 🇺🇸 영어

📝 소개

TypeScript Express Starter는 원하는 스택 구성으로 프로덕션 준비된 TypeScript Express 프로젝트를 생성하는 대화형 CLI 도구입니다.

처음부터 시작하는 대신, 이 CLI는 다양한 데이터베이스 연동, 개발 도구, 배포 구성을 포함한 포괄적인 프로젝트 생성기를 제공합니다. 10개 이상의 템플릿 중 선택하고 몇 분 안에 개발 워크플로우를 맞춤 설정할 수 있습니다.

• 대화형 설정: 데이터베이스, ORM, 린터, 테스트 프레임워크 등을 선택
• 프로덕션 준비: Docker, PM2, NGINX 구성 포함
• 개발자 경험: 핫 리로드, 테스트, 린팅, 포맷팅이 미리 구성됨
• 다양한 스택: 10개 이상의 데이터베이스/ORM 조합 지원

💎 CLI 주요 기능

• 🎯 대화형 설정 — 스마트 CLI로 프로젝트 구성을 안내

• 🚀 빠른 시작/커스텀 모드 — 프리셋으로 빠르게 시작하거나 카테고리별로 직접 선택

• 🗄️ 다양한 데이터베이스 옵션 — Prisma, Sequelize, TypeORM, Mongoose, Knex 등

• 🛠️ 개발 도구 — ESLint, Biome, Jest, Vitest, Docker, PM2 중 선택

• 📱 템플릿 선택 — 10개 이상의 사전 구성된 프로젝트 템플릿

• ⚡ 자동 구성 — 의존성, 스크립트, 설정이 자동으로 설정됨

• 🔧 스마트 의존성 — 도구 호환성 및 요구사항 자동 해결

• 📦 패키지 매니저 지원 — npm, pnpm, yarn 모두 지원

• 🚀 제로 설정 시작 — 생성된 프로젝트가 즉시 동작

• 🎨 커스터마이징 가능 — 자신만의 템플릿과 개발 도구 추가

⚡️ 빠른 시작

# 전역 설치
npm install -g typescript-express-starter

# 대화형 CLI 실행
typescript-express-starter

┌  📘 TypeScript Express Starter
│
◇  Choose setup mode:
│  ● 🚀 Quick start (recommended preset) (Automatically selects a sensible toolset)
│  ○ 🛠 Custom (step-by-step) (Pick tools category by category)
│
◇  Which package manager do you want to use?
│  ● npm
│  ○ pnpm
│  ○ yarn
│
◇  Choose a template:
│  ● Express TypeScript (Basic Express + TypeScript starter · beginner · stable)
│  ○ Drizzle PostgreSQL (Modern SQL toolkit with type safety + full devtools · intermediate · stable)
│
◇  Enter your project name:
│  your-project-name
│
◇  Choose quick profile:
│  ○ Minimal (Template only (no additional devtools))
│  ● Recommended (Balanced default toolchain)
│  ○ Full (One tool from each category)
│
◇  Preset ────────────────────────────────────────────────────────────╮
│                                                                     │
│  Quick profile selected: recommended (biome, tsup, vitest, docker)  │
│                                                                     │
├─────────────────────────────────────────────────────────────────────╯
│
◇  Configuration summary ────────────────────────╮
│                                                │
│  Setup mode     : quick                        │
│  Package manager: pnpm                         │
│  Template       : Express TypeScript           │
│  Project name   : your-project-name            │
│  Devtools       : Biome, tsup, Vitest, Docker  │
│                                                │
├────────────────────────────────────────────────╯
│
◆  Proceed with project generation?
│  ● Yes / ○ No
│
✔ 📦 Base dependencies installed!
│
└ 🎉 Project setup complete!

# 프로젝트로 이동
cd your-project-name

# 개발 서버 시작
npm run dev

생성된 프로젝트 기능:

• 🌐 Express 서버: http://localhost:3000/
• 🔄 nodemon을 통한 핫 리로드

📂 프로젝트 구조

your-project/
├── src/
│   ├── config/           # 환경 변수, 설정 파일
│   ├── controllers/      # 요청 처리 및 응답 반환
│   ├── dtos/             # 요청/응답 데이터 구조 정의
│   ├── entities/         # 데이터베이스 엔티티 정의 (ORM 사용 시)
│   ├── exceptions/       # 커스텀 예외 클래스
│   ├── interfaces/       # 타입/인터페이스 정의
│   ├── middlewares/      # 미들웨어 (로그, 인증, 에러 처리 등)
│   ├── repositories/     # 데이터베이스 접근 로직
│   ├── routes/           # 라우팅 정의
│   ├── services/         # 비즈니스 로직
│   ├── utils/            # 유틸리티 함수
│   ├── app.ts            # Express 앱 초기화
│   └── server.ts         # 서버 실행 엔트리 포인트
├── .env                   # 환경 변수 파일
├── .env.development.local # 개발 환경 변수
├── .env.production.local  # 운영 환경 변수
├── .env.test.local        # 테스트 환경 변수
├── nodemon.json           # Nodemon 환경 변수
├── package.json           # 프로젝트 의존성 및 스크립트
└── tsconfig.json          # TypeScript 환경 변수

🛠 사용 가능한 개발 도구

프로젝트 설정 중 다음 카테고리에서 선택할 수 있습니다:

나중에 추가될 예정 (현재 개발 중):

스마트 선택: CLI가 도구 의존성과 호환성을 자동으로 해결합니다.

🧩 사용 가능한 템플릿

포괄적인 호환성 테스트를 완료한 현재 템플릿 상태:

✅ 프로덕션 준비 및 완전 테스트 완료

🔧 향상된 개발 도구 지원

drizzle-postgresql 템플릿은 다음과 완전 호환됩니다:

린터

• ✅ Biome - 현대적 통합 도구 (린터 + 포맷터)
• ✅ ESLint + Prettier - 전통적이고 안정적인 조합
• ✅ Oxlint - Rust 기반 고성능 린터 (18ms!)

컴파일러

• ✅ tsup - esbuild 기반 번들러 (193ms 빌드!)
• ✅ SWC - Rust 기반 네이티브 성능 컴파일러

테스트 러너

• ✅ Jest - 완전한 E2E 지원을 가진 성숙한 테스트 프레임워크
• ✅ Vitest - 현대적 Vite 기반 테스트 러너

🎯 8가지 조합 모두 테스트 및 검증 완료 - 원하는 개발 경험을 선택하세요!

🚧 개발 예정

ORM/데이터베이스 연동

아키텍처/컨트롤러 스타일

🤔 이 CLI를 사용하는 이유?

vs. 수동 설정

vs. 다른 생성기

⭐️ 응원해주신 분들

🍴 참고하시는 분들

🤝 도움주신 분들

💳 라이선스

MIT

Made with ❤️ by AGUMON 🦖