generator expressjs rest Unduh - generator expressjs rest Unduh kode sumber

generator expressjs rest

Kategori lainnya

v1.9.0

Unduh

Istirahat Generator Expressjs

Fitur

Registrasi Pengguna
Otentikasi Dasar dengan nama pengguna dan kata sandi
Admin menggunakan reaksi-admin
Otentikasi Oauth 2.0
- Facebook
- Google
Unggah Foto ke S3 amazon
Buruh pelabuhan

Prasyarat

buruh pelabuhan (setidaknya 1.10)
Penulisan Docker (setidaknya 1.6)

Instalasi

Pertama, instal Yeoman dan generator-expressjs-rest menggunakan npm (kami berasumsi Anda sudah menginstal node.js).

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

Generator

Kemudian, Anda dapat menggunakan yo untuk menghasilkan proyek Anda.

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

Perintah

Setelah Anda membuat proyek Anda, perintah ini.

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

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

Bermain secara lokal

Menyebarkan

Struktur direktori

Ringkasan

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/

Di sinilah titik akhir API ditentukan. Setiap API memiliki foldernya sendiri.

src/api/some-endpoint/model.js

Ini mendefinisikan skema dan model Mongoose untuk titik akhir API. Setiap perubahan pada model data harus dilakukan di sini.

src/api/some-endpoint/controller.js

Ini adalah file pengontrol API. Ini mendefinisikan middleware router utama yang menggunakan model API.

src/api/some-endpoint/index.js

Ini adalah file entri API. Ini mendefinisikan rute menggunakan, bersama middleware lainnya (seperti sesi, validasi, dll.), middleware yang ditentukan dalam file some-endpoint.controller.js .