generator expressjs rest

Generator Expressjs Rest

Merkmale

• Benutzerregistrierung
• Basisauthentifizierung mit Benutzername und Passwort
• Der Administrator verwendet React-Admin
• OAuth 2.0-Authentifizierung
  • Facebook
  • Google
• Foto auf S3 Amazon hochladen
• Docker

Voraussetzungen

• Docker (mindestens 1.10)
• Docker-compose (mindestens 1.6)

Installation

Installieren Sie zunächst Yeoman und Generator-ExpressJS-Rest mit npm (wir gehen davon aus, dass Sie node.js vorinstalliert haben).

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

Generatoren

Anschließend können Sie yo zum Generieren Ihres Projekts verwenden.

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

Befehle

Nachdem Sie Ihr Projekt generiert haben, folgen diese Befehle.

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

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

Lokal spielen

Einsetzen

Verzeichnisstruktur

Überblick

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

src/api/

Hier werden die API-Endpunkte definiert. Jede API verfügt über einen eigenen Ordner.

src/api/some-endpoint/model.js

Es definiert das Mongoose-Schema und -Modell für den API-Endpunkt. Alle Änderungen am Datenmodell sollten hier vorgenommen werden.

src/api/some-endpoint/controller.js

Dies ist die API-Controller-Datei. Es definiert die wichtigsten Router-Middlewares, die das API-Modell verwenden.

src/api/some-endpoint/index.js

Dies ist die Eintragsdatei der API. Es definiert die Routen unter Verwendung der in der Datei some-endpoint.controller.js definierten Middlewares, zusammen mit anderen Middlewares (wie Sitzung, Validierung usw.).

Dienstleistungen/

Hier können Sie helpers , libraries und andere Arten von Modulen einfügen, die Sie in Ihren APIs verwenden möchten.

TODO

• Unterstützt optionale Telefonauthentifizierung
• Unterstützen Sie den optionalen E-Mail-Bestätigungsprozess
• Unterstützen Sie Twitter und andere soziale Anmeldemethoden
• Socket.io-Unterstützung

PRs sind willkommen.

Credits

@minhuyen und alle Mitwirkenden

Lizenz

MIT © minhuyen