generator expressjs rest

Generator Expressjs 나머지

특징

• 사용자 등록
• 사용자 이름과 비밀번호를 사용한 기본 인증
• 관리자는 반응 관리자를 사용합니다.
• Oauth 2.0 인증
  • 페이스북
  • Google
• S3 Amazon에 사진 업로드
• 도커

전제 조건

• 도커(최소 1.10)
• Docker-compose(최소 1.6)

설치

먼저, npm을 사용하여 Yeoman과 Generator-expressjs-rest를 설치합니다(node.js가 사전 설치되어 있다고 가정합니다).

npm install -g yo
npm install -g generator-expressjs-rest

발전기

그런 다음 yo 사용하여 프로젝트를 생성할 수 있습니다.

yo expressjs-rest # generate a new project
yo expressjs-rest:api # generate a new api endpoint inside your project 

명령

프로젝트를 생성한 후 다음 명령을 실행하세요.

 cd your-project-name
mv .env.example .env

docker-compose build
docker-compose run --rm client yarn build
docker-compose up

로컬에서 플레이하기

배포

디렉토리 구조

개요

src/
├─ api/
│  ├─ auth/
│  │  ├─ index.js
│  │  ├─ auth.service.js
│  │  ├─ auth.validation.js
│  │  ├─ auth.controller.js
│  │  └─ auth.test.js
│  ├─ uploads/
│  │  ├─ index.js
│  │  ├─ upload.controller.js
│  ├─ users/
│  │  ├─ index.js
│  │  ├─ user.controller.js
│  │  ├─ user.validation.js
│  │  ├─ user.model.js
│  │  ├─ user.service.js
│  │  └─ user.test.js
│  └─ index.js
├─ services/
│  ├─ index.js
│  ├─ jwt.js
│  ├─ logger.js
│  ├─ mailgun.js
│  ├─ mongoose.js
│  ├─ passport.js
│  ├─ response.js
│  ├─ s3.js
│  ├─ swagger.js
│  └─ your-service.js
├─ app.js
├─ config.js
└─ index.js

소스/API/

여기에서 API 엔드포인트가 정의됩니다. 각 API에는 자체 폴더가 있습니다.

src/api/some-endpoint/model.js

이는 API 엔드포인트에 대한 Mongoose 스키마와 모델을 정의합니다. 데이터 모델에 대한 모든 변경은 여기에서 수행되어야 합니다.

src/api/some-endpoint/controller.js

API 컨트롤러 파일입니다. API 모델을 사용하는 주요 라우터 미들웨어를 정의합니다.

src/api/some-endpoint/index.js

API의 항목 파일입니다. 이는 다른 미들웨어(예: 세션, 유효성 검사 등)와 함께 some-endpoint.controller.js 파일에 정의된 미들웨어를 사용하여 경로를 정의합니다.

서비스/

여기에는 API에서 사용하려는 helpers , libraries 및 기타 유형의 모듈을 넣을 수 있습니다.

TODO

• 선택적 전화 인증 지원
• 선택적 이메일 확인 프로세스 지원
• Twitter 및 기타 소셜 로그인 방법 지원
• Socket.io 지원

PR을 환영합니다.

크레딧

@minhuyen 및 모든 기여자

특허

MIT © 민후엔