Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: 전체 개발 모드 추가 #702

Merged
merged 3 commits into from
Aug 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions docs/docs/tutorials/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,20 @@ corepack prepare pnpm@latest --activate
pnpm install
```

3. `backend/`가 `contracts/` 패키지에 의존하므로, 터미널 창을 2개 준비해주세요.
3. 프로젝트 루트에서 다음 명령어를 실행해 개발 모드를 실행해주세요.

```sh
# 터미널 #1
cd contracts
pnpm dev

# 터미널 #2
cd backend
pnpm dev
```

4. 올바르게 실행된다면 `https://localhost:3000/swagger-v2` 경로에 접속해 API 문서를 확인하실 수 있습니다.
4. 올바르게 실행된다면 <localhost:3000/swagger>와 <localhost:3000/swagger-v2>
경로에 접속해 API 문서를 확인하실 수 있습니다.

| [V1 OpenApi 명세][swagger-url] | [V2 OpenApi 명세][swagger-v2-url] |
| :----------------------------: | :-------------------------------: |
| ![][swagger] | ![][swagger-v2] |

![swagger-v2](https://github.com/jiphyeonjeon-42/backend/assets/54838975/21c160f9-150b-4321-a9fa-0c61842477b0)
[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
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -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"
}
}