Toggle navigation
Toggle navigation
This project
Loading...
Sign in
강동현
/
nodejs-game
Go to a project
Toggle navigation
Toggle navigation pinning
Projects
Groups
Snippets
Help
Project
Activity
Repository
Pipelines
Graphs
Issues
0
Merge Requests
0
Wiki
Snippets
Network
Create a new issue
Builds
Commits
Issue Boards
Authored by
강동현
2021-06-10 12:26:07 +0900
Browse Files
Options
Browse Files
Download
Email Patches
Plain Diff
Commit
aa243741b0320cdefaf4c203bac00cf1e94b2497
aa243741
1 parent
03ed220b
Builds for 1 pipeline
passed
in 8 minutes 1 second
README.md 수정
Changes
1
Builds
3
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
14 additions
and
6 deletions
README.md
README.md
View file @
aa24374
...
...
@@ -13,21 +13,21 @@ Typescript로 작성된 오픈소스 그림퀴즈 웹 어플리케이션입니
[
백엔드
](
./server
)
와
[
프론트엔드
](
./web
)
를 모두 포함합니다.
## 백엔드 (./server)
Express와 socket.io를 기반으로 한 node.js 서버입니다.
소켓 통신 규약은
[
PROTOCOL.md
](
http://khuhub.khu.ac.kr/2020105578/nodejs-game/blob/develop/PROTOCOL.md
)
에 정의되어 있습니다.
### Usage
`$ yarn`
으로 의존성을 설치합니다.
!! 이하 작성해주세요.
CORS 설정, 포트 설정, 빌드, 실행 등등
`$ yarn start`
로 서버를 엽니다. 포트는 3000입니다.
`$ yarn test`
로 서버 코드를 테스트합니다.
`$ yarn build`
로 서버를 빌드합니다.
## 프론트엔드 (./web)
...
...
@@ -37,9 +37,17 @@ React.js와 tailwindcss를 기반으로 한 클라이언트입니다.
`$ npm i`
로 의존성을 설치합니다.
본인의 백엔드 서버 URI를
[
SocketContext.ts
](
.
/src/contexts/SocketContext.ts
)
에 입력합니다.
본인의 백엔드 서버 URI를
[
SocketContext.ts
](
http://khuhub.khu.ac.kr/2020105578/nodejs-game/blob/develop/web
/src/contexts/SocketContext.ts
)
에 입력합니다.
`$ npm start`
로 디버그용 개발 서버를 엽니다.
`$ npm run-script build`
로 프로덕션 빌드를 할 수 있습니다.
## 배포
Docker Compose를 통해 서버를 구성할 수 있습니다. 프론트엔드 페이지는 빌드되어 nginx로 서빙됩니다. 리포지토리 최상단 디렉토리에서
`$ docker-compose up`
를 입력하세요.
## 브랜치
-
`develop`
: 현재 개발중인 버전입니다.
-
`master`
: 릴리즈된 버전입니다.
...
...
Please
register
or
login
to post a comment