Getting started

국방프렌즈 프로젝트를 직접 실행시키는 방법을 다룹니다.

1. 국방프렌즈 저장소를 클론합니다.

$ git clone https://github.com/osamhack2020/WEB_KookbangFriends_Woowahan

2. 클론한 폴더로 이동하고 패키지를 설치합니다.

// 클라이언트 패키지 설치
$ cd WEB_KookbangFriends_Woowahan/web/client
$ yarn install
$ yarn add next

// 서버 패키지 설치
$ cd ../api
$ yarn install

3. docker-compose 설정을 진행합니다.

// web/docker-compose.yml 파일을 본인 환경에 맞게 수정합니다.
// 컨테이너 명, 포트 정보, DB 정보를 수정하시면 됩니다.
// 기본 포트 (클라이언트 : 3000, 서버 : 1337, DB : 27017) 
// 가이드 참조 : https://docs.docker.com/compose/gettingstarted/

4. docker-compose로 컨테이너를 빌드합니다.

// web 폴더로 이동 후 docker-compose 빌드
$ cd ../
$ docker-compose build

5. docker-compose로 컨테이너를 작동시킵니다.

// docker-compose 실행
$ docker-compose up

현재 GitHub repository에는 기본적인 DB와 리소스 파일이 같이 업로드가 되어있어 API 및 DB 폴더는 초기화 후에 진행하는 것을 권장드립니다.