generator expressjs rest

Expressjs 休息產生器

特徵

• 用戶註冊
• 使用使用者名稱和密碼進行基本身份驗證
• 管理員使用react-admin
• Oauth 2.0 身份驗證
  • Facebook
  • Google
• 將照片上傳到亞馬遜S3
• 碼頭工人

先決條件

• Docker（至少 1.10）
• Docker-compose（至少 1.6）

安裝

首先，使用 npm 安裝 Yeoman 和產生器-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和其他類型的模組。

待辦事項

• 支援可選的電話認證
• 支援可選的電子郵件確認流程
• 支持Twitter等社群登入方式
• Socket.io 支持

歡迎 PR。

製作人員

@minhuyen 和所有貢獻者

執照

麻省理工學院©minhuyen