와인 시커의 백엔드 입니다. express.js 기반의 REST API 서버이며, prisma orm을 사용하였고 esm을 사용한 js로 컴파일 되는 타입스크립트로 작성하였습니다.
이 앱을 실행하려면 컴퓨터에 node.js 20 버전이 설치되어야 합니다. 이 외의 버전은 정상 작동을 장담할 수 없으며, 실제로 이 앱은 node.js 18 이하 버전에 서 오작동 합니다.
- node.js 20 버전을 설치합니다. 권장하는 방법은 nvs(윈도우 환경에서 권장), nvm(맥, 리눅스 등에서 권장) 등의 버전 관리자를 사용하는 것입니다. node.js 20 버전이 설치되어있으면 이를 생략합니다.
- IDE 혹은 에디터를 설치합니다. 권장하는 에디터는 젯브레인즈 사의 웹스톰(WebStorm)이며 mju.ac.kr 메일을 통해 학생 라이선스를 발급 받을 수 있습니다. VS Code를 써도 상관이 없으나, 편의성 면에서는 웹스톰이 우위입니다. 웹스톰은 데이터베이스 엑서스를 기본적으로 지원하지 않아서 유료 플러그인을 설치해야 하나, 학생 라이선스 보유자, 데이터그립 라이선스 보유자, 올 프로덕트팩 라이선스 보유자는 무료입니다.
npm install .env.sample파일을.env파일로 복사하세요. 그 다음 데이터베이스 URL에 적절한 값을 작성합니다. 데이터베이스 URL 작성방식은 아래와 같으며 포트는 기본적인 MySQL 설치 환경에서는 3306 포트입니다. HOST 란은 로컬에 있는 DB 사용시 localhost 입니다.mysql://USER:PASSWORD@HOST:PORT/DATABASE- 다음 명령어로 프리즈마 마이그레이트를 실행합니다. 이 명령어는 개발 환경 전용 명령어로 프로덕션에서 실행하면 안됩니다.
npx prisma migrate dev - 프리즈마 제너레이트 명령어를 실행합니다.
npx prisma generate - 아래와 같은 명령어로 개발 서버를 실행합니다.
npm run dev
데이터베이스 스키마는 schema.prisma 파일에 정의되어 있습니다. 프리즈마 스키마에 대한 정보는 https://www.prisma.io/docs/orm/prisma-schema/overview 에서 보실 수 있습니다. 데이터타입에 대한 정보는 https://www.prisma.io/docs/orm/prisma-schema/data-model/models#native-types-mapping 에서 확인 가능합니다.
데이터베이스 스키마를 바꾸신 다음 반드시 npx prisma migrate dev를 실행해야 하며, npx prisma migrate dev를 실행한 다음 지체없이 prisma 폴더를 커밋하셔야 합니다.
구글 타입스크립트 스타일 가이드의 것을 차용하여 클래스, 인터페이스, 타입, 열거형(enum), 타입 파라미터에서는 파스칼 표기법을 사용하고 변수, 함수 파라미터 등의 파라미터, 함수명, 메소드명, 속성, 모듈 별칭은 카멜 표기법을 사용합니다.
파일명의 경우 케밥 표기법(예. lucia-auth.ts)을 사용합니다. npm 패키지명도 캐밥 표기법을 사용하고 있으며, 카멜 표기법 내지 파스칼 표기법을 사용할 경우 luciaAuth.ts와 luciaauth.ts가 공존시키는 실수를 할 경우 OS간의 대소문자 구별법이 달라서 혼선을 일으킬 수 있으며, 구글 자바스크립트 스타일 가이드에서도 사실상 스네이크 표기법 내지는 케밥 표기법을 권장하고 있기 때문입니다. 이 프로젝트에는 처음부터 케밥 표기법을 사용 중이었기 때문에 케밥 표기법을 사용합니다.
swagger-output.json 파일은 swagger-autogen에서 생성하는 파일로 API 정의가 자동으로 생성됩니다. 수정할 부분이 있을 경우 swagger-autogen에서 정하는 대로 API 정의가 수정되도록 해야합니다. swagger-output.json 파일에 출력되는 내용을 바꾸고 싶다면 https://swagger-autogen.github.io/docs 를 참고하세요.