📝 [Docs] Ghostpong 실행방법

[jis-kim]

1. Development 환경으로 실행

개발 단계에서 실시간으로 컴파일이 필요한 경우

• backend directory 에서 .env.development 작성

• yarn -> yarn db -> yarn start:dev 혹은 yarn start:prod 실행

• seeding 이 필요하다면 yarn seed [number] 실행

  • 기존에 seeding 을 진행한 적이 있다면 volume (db_dev_data) 이 저장되기 때문에 실행하지 않아도 됩니다.

• frontend directory 에서 yarn -> yarn dev 혹은 yarn prod 실행

• 필수로 변경해야 할 값

  • 기존 DB_ 변수들을 POSTGRES_ 로 변경해주세요.
  • POSTGRES_HOST 는 localhost 로 지정해주세요.
  • 로컬에 postgres 가 돌고 있으면 기본 포트인 5432 와 충돌이 날 수 있기 때문에 가급적 5432 이외 사용하지 않는 포트를 환경변수로 설정해 주시길 바랍니다.
  • db 컨테이너 로그가 이런 식이면 포트 충돌일 가능성이 높습니다.
    

  env.development

  NODE_ENV=development
  POSTGRES_PORT=
  POSTGRES_HOST=localhost
  POSTGRES_NAME=
  POSTGRES_USER=
  POSTGRES_PASSWORD=
  

2. Production 환경으로 실행

server, client, DB 를 모두 도커라이징하고 테스트하고 싶을 경우

• backend directory 에서 .env 작성

• root directory 에서 docker compose up --build 실행

• 필수로 변경해야 할 값

  • 기존 DB_ 변수들을 POSTGRES_ 로 변경해주세요.
  • POSTGRES_HOST 는 ghostgres 로 지정해주세요.

  .env

  NODE_ENV=production
  POSTGRES_PORT=
  POSTGRES_HOST=ghostgres
  POSTGRES_NAME=
  POSTGRES_USER=
  POSTGRES_PASSWORD=
  

이전 실행 방법

nest.js app 초기 실행

backend 디렉토리 안에서 실행해주세요.

• .env.sample 파일 참고해서 .env 파일 작성
• yarn install
• yarn db
• yarn start:prod 또는 yarn start:dev
  • yarn start:prod : NODE_ENV=production 환경변수 설정해서 클라이언트가 Authorization header로 'token' 담아서 통신할 때 사용
  • yarn start:dev : NODE_ENV=development 환경변수 설정해서 클라이언트가 x-my-id header로 'user id' 담아서 통신할 때 사용

DB 테이블이 존재하는 상태에서 실행

• psql 실행 없이 yarn db 후 바로 yarn run start 해주시면 됩니다.
• yarn db:reset 으로 볼륨을 삭제하고 다시 초기 실행할 수도 있습니다.

DB seeding

• .env 파일에 TEST_DB_NAME 설정 되었는지 확인합니다. (해당 환경변수를 읽어서 실행합니다.)
• yarn seed:reset && yarn seed [number]
  • yarn seed:reset 시 테스트 데이터베이스가 날아갔다가 다시 생성되므로 사용에 주의해주세요!
  • [number] 자리에는 생성하고자 하는 auth 의 row 수를 입력합니다. 확률에 따라 user, friendship, message, game_history 가 차례로 생성됩니다.

Swagger

• nest app 실행해주시고 localhost:${APP_PORT}/api 로 접속하시면 swagger 로 테스트 하실 수 있습니다.