Bootstrapping

준비물

JavaScript ES6으로 작성된 프로젝트입니다. 개발 환경에서는 babel-node로, 빌드 시에는 webpack으로 빌드합니다. Node 8.10.0 이상의 환경을 권장합니다. (Production, stage 서버에서는 Node 12.11.1)

$ node -v // v8.10.0 or later

개발 환경에서 db_dev에 접근하기 위해서는 (configuration/production 문서 참조) 143.248.234.0/24 IP 대역에서 접속해야 합니다. ssal과 같은 SPARCS 개발 서버 내에서, 또는 SPARCS Whale 컨테이너 내에서 개발 환경을 설정하는 것을 추천합니다.

설치

git clone https://github.com/sparcs-kaist/kono.git
cd kono/kono-api
npm install

환경 변수를 설정하기 위해 다음과 같은 .env 파일을 만들어 kono-api 디렉토리 내에 추가합니다.

운영 환경의 경우 docker-compose에 의해 환경 변수가 설정됩니다.

.env

HOST=[your API server host name]
PORT=[your API server port]
DB_HOST=[your database server IP / DNS]
DB_PORT=[your database server port]
DB_AUTH_USER=[authorized username for your database]
DB_AUTH_PASSWORD=[authorized user's password for your database]
DB_USER=[username for your database]
DB_PASSWORD=[password for your database]
DB_DATABASE=[database name of use]
PASSWORD_KEY=[a secret string for password hashing]
JWT_KEY=[a secret string for JWT assignation]
UPLOAD_DIR=[directory path for saving uploaded files]

실제 값들은 공식 문서에서 숨겨져 있습니다. PM에게 문의하세요.

개발 서버를 실행할 때 코드 수정 시 프로세스를 자동으로 재시작할 수 있는 nodemon module을 사용하는 것을 추천합니다. (NPM script는 nodemon 사용)

$ npm install --global nodemon

실행

서버 실행 방법:

$ npm run start:dev