generator expressjs rest

Генератор Expressjs Rest

Функции

• Регистрация пользователя
• Базовая аутентификация с использованием имени пользователя и пароля
• Администратор использует реакцию-администратора
• Аутентификация OAuth 2.0
  • Фейсбук
  • Google
• Загрузить фото на S3 Amazon
• Докер

Предварительные условия

• Докер (минимум 1.10)
• Docker-compose (минимум 1.6)

Установка

Сначала установите Yeoman и генератор-expressjs-rest с помощью npm (мы предполагаем, что у вас предварительно установлен 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

Он определяет схему и модель Mongoose для конечной точки API. Любые изменения в модели данных следует вносить здесь.

src/api/some-endpoint/controller.js

Это файл контроллера API. Он определяет основное промежуточное ПО маршрутизатора, использующее модель API.

src/api/some-endpoint/index.js

Это входной файл API. Он определяет маршруты, используя наряду с другими промежуточными программами (например, сеанс, проверку и т. д.) промежуточное программное обеспечение, определенное в файле some-endpoint.controller.js .

услуги/

Здесь вы можете разместить helpers , libraries и другие типы модулей, которые вы хотите использовать в своих API.

TODO

• Поддержка дополнительной аутентификации по телефону
• Поддержка дополнительного процесса подтверждения по электронной почте
• Поддержка Twitter и других методов входа в социальные сети.
• Поддержка Socket.io

Пиар приветствуется.

Кредиты

@minhuyen и все участники

Лицензия

Массачусетский технологический институт © минхуен