From 1890d30d2f8ec9cfc6ef75990454b9f1cc856e19 Mon Sep 17 00:00:00 2001 From: scarf Date: Sat, 26 Aug 2023 22:33:48 +0900 Subject: [PATCH 1/3] =?UTF-8?q?build:=20=EC=A0=84=EC=B2=B4=20=EA=B0=9C?= =?UTF-8?q?=EB=B0=9C=20=EB=AA=A8=EB=93=9C=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- package.json | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index f3cc080d..407bc0ec 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,14 @@ { + "scripts": { + "dev": "pnpm -r --parallel dev" + }, "dependencies": { "zod": "^3.22.2", "@ts-rest/core": "^3.28.0" }, - "devDependencies": { + "devDependencies": { "typescript": "5.1.6", "@types/node": "18.16.1", - "rome": "^12.1.3" - } + "rome": "^12.1.3" + } } From a2375bed049d79aff4b8575b86a15cd588127ae0 Mon Sep 17 00:00:00 2001 From: scarf Date: Sat, 26 Aug 2023 22:40:02 +0900 Subject: [PATCH 2/3] =?UTF-8?q?docs:=20=ED=94=84=EB=A1=9C=EC=A0=9D?= =?UTF-8?q?=ED=8A=B8=20=EC=8B=A4=ED=96=89=20=EB=B0=A9=EB=B2=95=20=EA=B0=84?= =?UTF-8?q?=EB=9E=B5=ED=99=94?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/docs/tutorials/setup.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/docs/tutorials/setup.md b/docs/docs/tutorials/setup.md index b7889dcd..ca316d62 100644 --- a/docs/docs/tutorials/setup.md +++ b/docs/docs/tutorials/setup.md @@ -14,15 +14,9 @@ corepack prepare pnpm@latest --activate pnpm install ``` -3. `backend/`가 `contracts/` 패키지에 의존하므로, 터미널 창을 2개 준비해주세요. +3. 프로젝트 루트에서 다음 명령어를 실행해 개발 모드를 실행해주세요. ```sh -# 터미널 #1 -cd contracts -pnpm dev - -# 터미널 #2 -cd backend pnpm dev ``` From 4c830f34a6f59823eff926289c26e3d439d92d3e Mon Sep 17 00:00:00 2001 From: scarf Date: Sat, 26 Aug 2023 22:45:17 +0900 Subject: [PATCH 3/3] =?UTF-8?q?docs:=20V1=20=EB=AA=85=EC=84=B8=20=EC=84=A4?= =?UTF-8?q?=EB=AA=85=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/docs/tutorials/setup.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/docs/tutorials/setup.md b/docs/docs/tutorials/setup.md index ca316d62..ee80fe89 100644 --- a/docs/docs/tutorials/setup.md +++ b/docs/docs/tutorials/setup.md @@ -20,6 +20,14 @@ pnpm install pnpm dev ``` -4. 올바르게 실행된다면 `https://localhost:3000/swagger-v2` 경로에 접속해 API 문서를 확인하실 수 있습니다. +4. 올바르게 실행된다면 와 + 경로에 접속해 API 문서를 확인하실 수 있습니다. -![swagger-v2](https://github.com/jiphyeonjeon-42/backend/assets/54838975/21c160f9-150b-4321-a9fa-0c61842477b0) +| [V1 OpenApi 명세][swagger-url] | [V2 OpenApi 명세][swagger-v2-url] | +| :----------------------------: | :-------------------------------: | +| ![][swagger] | ![][swagger-v2] | + +[swagger-url]: localhost:3000/swagger +[swagger-v2-url]: localhost:3000/swagger-v2 +[swagger]: https://github.com/jiphyeonjeon-42/backend/assets/54838975/6d3bc1a2-c305-4a4e-be52-f6c9ef52c5e0 +[swagger-v2]: https://github.com/jiphyeonjeon-42/backend/assets/54838975/21c160f9-150b-4321-a9fa-0c61842477b0