generator expressjs rest Télécharger - generator expressjs rest Téléchargement du code source

generator expressjs rest

Autres catégories

v1.9.0

Télécharger

Générateur Expressjs Rest

Caractéristiques

Inscription des utilisateurs
Authentification de base avec nom d'utilisateur et mot de passe
L'administrateur utilise React-Admin
Authentification Oauth 2.0
- Facebook
- Google
Télécharger une photo sur S3 Amazon
Docker

Conditions préalables

Docker (au moins 1.10)
Docker-compose (au moins 1.6)

Installation

Premièrement, installez Yeoman et Generator-expressjs-rest en utilisant npm (nous supposons que vous avez pré-installé node.js).

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

Générateurs

Ensuite, vous pouvez yo utiliser pour générer votre projet.

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

Commandes

Après avoir généré votre projet, ces commandes.

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

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

Jouer localement

Déployer

Structure du répertoire

Aperçu

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/

C'est ici que les points de terminaison de l'API sont définis. Chaque API possède son propre dossier.

src/api/some-endpoint/model.js

Il définit le schéma et le modèle Mongoose pour le point de terminaison de l'API. Toute modification du modèle de données doit être effectuée ici.

src/api/some-endpoint/controller.js

Il s'agit du fichier du contrôleur API. Il définit les principaux middlewares de routeur qui utilisent le modèle API.

src/api/some-endpoint/index.js

Il s'agit du fichier d'entrée de l'API. Il définit les routes en utilisant, avec d'autres middlewares (comme la session, la validation, etc.), les middlewares définis dans le fichier some-endpoint.controller.js .