generator expressjs rest

Expressjs 休息生成器

特征

• 用户注册
• 使用用户名和密码进行基本身份验证
• 管理员使用react-admin
• Oauth 2.0 身份验证
  • Facebook
  • 谷歌
• 将照片上传到亚马逊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