generator expressjs rest

ジェネレーター Expressjs レスト

特徴

• ユーザー登録
• ユーザー名とパスワードによる基本認証
• 管理者はreact-adminを使用します
• Oauth 2.0認証
  • フェイスブック
  • グーグル
• 写真を S3 アマゾンにアップロード
• ドッカー

前提条件

• Docker (少なくとも 1.10)
• Docker-compose (少なくとも 1.6)

インストール

まず、npm を使用して Yeoman と generated-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 © ミンフエン