programmers의 과제 테스트는 코드를 제출하면 자동으로 서버를 구성하여 실행해 볼 수 있는 환경을 제공합니다.
아래 내용을 확인하여 프로젝트를 구성하고 코드를 제출해 주세요.
참고: 이 템플릿은 웹 어플리케이션 모듈인 express.js 와 SQL을 위한 ORM(Object-Relational Mapping) 모듈인 sequelize.js 가 미리 구성되어 있습니다.
-
Port 번호는 PORT 환경 변수 또는 5000 을 사용해야 합니다.
-
programmers에서 과제 실행 및 제출 시에는
NODE_ENV
는 production 으로 실행 됩니다. -
의존성 모듈들이 정의되어 있는
package.json
가 반드시 저장소에 루트 디렉토리에 있어야 합니다. -
package.json
의"scripts":"start"
에 프로젝트의 진입 명령어를 작성해야 합니다."scripts": { "start": "node index.js", "test": "node test.js" },
-
.gitignore
에 아래 항목들이 포함시켜 주세요.주의!:
node_modules
폴더와.env
파일이 저장소에 포함되어서는 안됩니다./node_modules npm-debug.log /*.env
-
Procfile
파일이 반드시 저장소의 루트 디렉토리에 있어야 하며, 다음과 같이 서버 프로세스를 실행하기 위한web
과 DB 마이그레이션을 위한migrate
가 정의되어 있어야 합니다.web: npm start migrate: ./node_modules/.bin/sequelize db:migrate
참고:
yarn
을 사용하고자 하는 경우, Procfile 파일의web: npm start
를 수정해주세요.참고:
sequelize
외의 다른 SQL 모듈을 이용하고자 하는 경우, 마이그레이션 cli 명령어를migrate:
에 작성해 주어야 합니다. -
programmers에서 과제 실행 및 제출 시에는
- 본인의 github 계정의 private 저장소를 생성해서 과제를 master 브랜치에 push 해주세요.
주의!: 저장소가 public으로 되어 있는 경우에는 programmers에서 과제를 실행/제출할 수 없습니다.
-
github 저장소 페이지의 Setting > Collaborators 에서 programmers-gitbot 을 Collaborator로 추가 해주세요.
-
실행시 github 저장소의 url을 입력하시고 [빌드(build)] 버튼을 누르면 자동으로 서버를 구성하여 실행 합니다. 실행 후에는 [최종 제출] 버튼이 활성화되어 과제를 제출 할 수 있습니다.
-
[최종 제출] 하면 테스트가 종료되며, 이후 다시 제출이 불가능하니 충분히 실행을 해보시고 제출하시기 바랍니다!!
주의!: [최종 제출] 되면 제출 당시의 master 브랜치의 commit으로 제출이 고정되므로 제출 이후 저장소에 commit을 push 해도 제출물에는 반영되지 않습니다.
-
programmers에서 실행된 서버는 최대 10분 뒤에는 자동으로 종료됩니다.
-
데이터베이스는 MySQL만 지원하며, 다른 데이터베이스 엔진은 지원하지 않습니다.
-
데이터베이스와 관련되어 정의되어 있는 환경 변수들은 다음과 같습니다.
- MySQL 접속 host:
MYSQL_ROOT_HOST=mysql-server
- MySQL 유저:
MYSQL_USER=root
- MySQL 유저의 비밀번호:
MYSQL_ROOT_PASSWORD=password
- 사전에 생성된 데이터베이스:
MYSQL_DATABASE=my_database
참고: 이 템플릿의
config/config.json
의 "production"에 정의되어 있는 값들을 참고해주세요. - MySQL 접속 host:
-
programmers에서 과제를 자동으로 실행할 때에는 마이그레이션을 위해 서버 실행 전 Procfile 파일의 migrate에 정의되어 있는 명령어를 실행합니다.
주의!: sequelize 외의 다른 모듈을 사용할 경우 Procfile 파일의 migrate을 사용 모듈의 마이그레이션 cli 명령어로 수정해주어야 합니다.
-
데이터베이스를 위한 모듈로 sequelize.js 을 사용할 경우, 다음 터미널 명령어로 마이그레이션 파일을 만들 수 있습니다. 마이그레이션 파일은
migrations
디렉토리에 생성됩니다.$ node_modules/.bin/sequelize model:generate --name User --attributes userId:string,name:string,engName:string
참고: 위의 명령어로 만들어진 마이그레이션 파일이 이 템플릿의
migrations/2019XXXXXXXXX-create-user.js
에 포함되어 있습니다. 이를 참고해주세요. -
programmers에서 자동으로 실행된 서버는 종료되면 데이터베이스 내의 데이터는 삭제됩니다.
-
git fetch failed! please check your repository.
잘못된 저장소 주소를 입력하거나 force commit으로 해당 commit이 없어진 경우 발생합니다.
-
-----> Unable to select a buildpack
저장소 root 디렉토리에
package.json
파일을 찾을 수 없습니다.package.json
파일을 확인해주세요. -
npm ERR! 혹은 error An unexpected error occurred
npm install 혹은 yarn install 중 에러가 발생했습니다. 로그에 표시된 해당 모듈을 확인해주세요.
-
ERROR: connect ECONNREFUSED 127.0.0.1:3306
MySQL host를 찾을 수 없습니다. MySQL host는 MYSQL_ROOT_HOST 환경변수 혹은 "mysql-server" 이여야 합니다.
주의!: programmers에서 과제 실행 시 MySQL host는 127.0.0.1(localhost)가 아니라 mysql-server임을 유의해주세요.
-
ERROR: Access denied for user 'root'@'172.17.0.3' (using password: YES)
MySQL 유저 혹은 비밀번호를 잘못 입력했습니다. 유저는 MYSQL_USER 환경 변수 혹은 "root", 비밀번호는 MYSQL_ROOT_PASSWORD 환경 변수 혹은 "password" 이여야 합니다.
주의!: 이 로그에서 나오는 ip 주소를 고정으로 사용하지 마세요. MySQL host의 ip 주소는 동적으로 변할 수 있습니다.
-
ERROR: Unknown database
database를 찾을 수 없습니다. database는 MYSQL_DATABASE 환경 변수 혹은 "my_database" 이여야 합니다.
-
Proc entrypoint migrate does not exist. Please check your Procfile
저장소 root 디렉토리에 Procfile 파일을 찾을 수 없거나 Procfile의 migrate가 정의되어 있지 않은 경우 발생합니다.
-
페이지가 작동하지 않습니다.
서버 실행에 실패했거나 서버가 실행된지 10분이 지나 종료되었습니다. Procfile의 web을 확인하여 서버 실행의 이상이 없는지 확인하세요. 이상이 없으면 [초기화] 후 다시 실행하세요.
programmers에서 실행된 과제는 다음 환경에서 동작합니다.
OS 버전: ubuntu 16.04
메모리 제한: 1024 MiB
MySQL 버전: 8.0.17
node.js 버전: 10.14.1
npm 버전: 6.4.1
yarn 버전: 1.12.3