강동현 / nodejs-game

Go to a project
Toggle navigation Toggle navigation pinning
강동현
aa243741 1 parent 03ed220b
Builds for 1 pipeline passed in 8 minutes 1 second

README.md 수정

Inline Side-by-side
Showing 1 changed file with 14 additions and 6 deletions
...@@ -13,21 +13,21 @@ Typescript로 작성된 오픈소스 그림퀴즈 웹 어플리케이션입니 ...@@ -13,21 +13,21 @@ Typescript로 작성된 오픈소스 그림퀴즈 웹 어플리케이션입니
13 13
14 [백엔드](./server)와 [프론트엔드](./web)를 모두 포함합니다. 14 [백엔드](./server)와 [프론트엔드](./web)를 모두 포함합니다.
15 15
16 -
17 -
18 ## 백엔드 (./server) 16 ## 백엔드 (./server)
19 17
20 Express와 socket.io를 기반으로 한 node.js 서버입니다. 18 Express와 socket.io를 기반으로 한 node.js 서버입니다.
21 19
20 +소켓 통신 규약은 [PROTOCOL.md](http://khuhub.khu.ac.kr/2020105578/nodejs-game/blob/develop/PROTOCOL.md)에 정의되어 있습니다.
21 +
22 ### Usage 22 ### Usage
23 23
24 `$ yarn`으로 의존성을 설치합니다. 24 `$ yarn`으로 의존성을 설치합니다.
25 25
26 -!! 이하 작성해주세요. 26 +`$ yarn start`로 서버를 엽니다. 포트는 3000입니다.
27 -
28 -CORS 설정, 포트 설정, 빌드, 실행 등등
29 27
28 +`$ yarn test`로 서버 코드를 테스트합니다.
30 29
30 +`$ yarn build`로 서버를 빌드합니다.
31 31
32 ## 프론트엔드 (./web) 32 ## 프론트엔드 (./web)
33 33
...@@ -37,9 +37,17 @@ React.js와 tailwindcss를 기반으로 한 클라이언트입니다. ...@@ -37,9 +37,17 @@ React.js와 tailwindcss를 기반으로 한 클라이언트입니다.
37 37
38 `$ npm i`로 의존성을 설치합니다. 38 `$ npm i`로 의존성을 설치합니다.
39 39
40 -본인의 백엔드 서버 URI를 [SocketContext.ts](./src/contexts/SocketContext.ts)에 입력합니다. 40 +본인의 백엔드 서버 URI를 [SocketContext.ts](http://khuhub.khu.ac.kr/2020105578/nodejs-game/blob/develop/web/src/contexts/SocketContext.ts)에 입력합니다.
41 41
42 `$ npm start`로 디버그용 개발 서버를 엽니다. 42 `$ npm start`로 디버그용 개발 서버를 엽니다.
43 43
44 `$ npm run-script build`로 프로덕션 빌드를 할 수 있습니다. 44 `$ npm run-script build`로 프로덕션 빌드를 할 수 있습니다.
45 45
46 +## 배포
47 +
48 +Docker Compose를 통해 서버를 구성할 수 있습니다. 프론트엔드 페이지는 빌드되어 nginx로 서빙됩니다. 리포지토리 최상단 디렉토리에서 `$ docker-compose up`를 입력하세요.
49 +
50 +## 브랜치
51 +
52 +- `develop`: 현재 개발중인 버전입니다.
53 +- `master`: 릴리즈된 버전입니다.
......