Skip to Content
문서시작하기시작하기

시작하기

이 섹션은 처음부터 ASAPJS 애플리케이션을 실행하기까지 필요한 모든 것을 안내합니다.

학습 목표

이 섹션을 마치면 다음을 갖추게 됩니다:

  • ASAPJS에서 요구하는 올바른 tsconfig.json 설정이 적용된 TypeScript 프로젝트
  • 필요한 모든 패키지 설치 (@asapjs/core, @asapjs/router, 선택적으로 @asapjs/sequelize)
  • curl 또는 브라우저로 호출할 수 있는 작동하는 REST API 엔드포인트
  • 권장 도메인 기반 폴더 구조에 대한 명확한 이해

섹션 개요

  1. 설치 — 사전 요구사항, 패키지 설치, TypeScript 설정. 새 프로젝트를 시작하는 경우 여기서 출발하세요.

  2. 첫 번째 API — 빈 디렉토리에서 실행 중인 엔드포인트까지 단계별로 안내합니다. 엔티티, DTO, 컨트롤러를 만들고 Application.run()으로 연결하는 과정을 다룹니다.

  3. 프로젝트 구조 — 도메인 기반 ASAPJS 프로젝트의 권장 폴더 레이아웃. 프레임워크가 엔티티, DTO, Socket 핸들러를 자동으로 찾을 수 있게 하는 명명 규칙을 학습합니다.

사전 요구사항

시작하기 전에 다음이 준비되어 있는지 확인하세요:

  • Node.js 18+ 설치
  • TypeScript 프로젝트 (또는 설정할 의향)
  • @asapjs/sequelize를 사용할 계획이라면 데이터베이스 — MySQL, PostgreSQL, MariaDB, 또는 로컬 개발용 SQLite

설치부터 시작해봅시다.

Last updated on