node-express-boilerplate

(★ 7,667)

A boilerplate for building production-ready RESTful APIs using Node.js, Express, and Mongoose

파일 탐색기

최종 버전 다운로드 (.zip)

- post-checkout
- post-commit
- pre-commit
- createNodejsApp.js
- - config.js
  - logger.js
  - morgan.js
  - passport.js
  - roles.js
  - tokens.js
- - auth.controller.js
  - index.js
  - user.controller.js
- - components.yml
  - swaggerDef.js
- - auth.js
  - error.js
  - rateLimiter.js
  - validate.js
- - index.js
  - token.model.js
  - user.model.js
- - auth.service.js
  - email.service.js
  - index.js
  - token.service.js
  - user.service.js
- - ApiError.js
  - catchAsync.js
  - pick.js
- - auth.validation.js
  - custom.validation.js
  - index.js
  - user.validation.js
- app.js
- index.js
- - token.fixture.js
  - user.fixture.js
- - auth.test.js
  - docs.test.js
  - user.test.js
- - setupTestDB.js
.dockerignore
.editorconfig
.env.example
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.lintstagedrc.json
.prettierignore
.prettierrc.json
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
docker-compose.dev.yml
docker-compose.prod.yml
docker-compose.test.yml
docker-compose.yml
Dockerfile
ecosystem.config.json
jest.config.js
LICENSE
package.json
README.md
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/hagopj13/node-express-boilerplate

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd node-express-boilerplate

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

yarn docker:dev

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn docker:prod

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn docker:test

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Node.js

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm init nodejs-express-app <project-name>

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

yarn dev

개발/실행 서버를 켭니다.

yarn start

개발/실행 서버를 켭니다.

yarn test

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.