generator-express-crud

A NPX tool that allows to the developer to deploy fast TypeScript backend apps only passing a few arguments:

• Backend port
• Mongo URL Database || Docker Mongo Database
• Entity model in YAML format

Stack

• ExpressJS
• Swagger
• Typescript 4
• Tsoa
• Mongoose
• Docker

Installation and execution example

Steps to reproduce:

1. Create test folder
2. Execute npm i generator-express-crud
3. Execute npx express-crud
4. Generate Swagger API documentation and running it by execution npm run dev

1-@Mac-Mini-M1 testFolder % npm i generator-express-crud
2
3up to date, audited 454 packages in 670ms
4
551 packages are looking for funding
6  run `npm fund` for details
7
8found 0 vulnerabilities
9-@Mac-Mini-M1 testFolder % npx express-crud            
10
11     _-----_     
12    |       |    
13    |--(o)--|    ╭──────────────────────────╮
14   `---------´   │  generator-express-crud  │
15    ( _´U`_ )    ╰──────────────────────────╯
16    /___A___\   /
17     |  ~  |     
18   __'.___.'__   
19 ´   `  |° ´ Y ` 
20
21? Insert you model .yaml filename that contains your data model business:  model.yaml
22? Insert the port where you want to startup your app:  8080
23? Insert your URL MongoDB database:  mongodb://mongo:dBIuBRCsFztpbBLdGpX5@containers-us-west-67.railway.app:6754
24Documentation API Generated via Swagger
25You can check it by executing 'npm run dev' and checking http://localhost:8080/docs
26 conflict package.json
27? Overwrite package.json? overwrite
28    force package.json
29   create src/database.ts
30   create tsconfig.json
31   create tsconfig-build.json
32   create tsoa.json
33   create nodemon.json
34   create src/ioc/ioc.ts
35   create src/dao/repository/AlumnoRepository.ts
36
37Changes to package.json were detected.
38
39Running npm install for you to install the required dependencies.
40   create src/interfaces/dao/IAlumnoDao.ts
41   create src/dao/AlumnoDaoImpl.ts
42   create src/models/entities/Alumno.ts
43   create src/interfaces/service/IAlumnoService.ts
44   create src/service/AlumnoServiceImpl.ts
45   create src/controllers/Alumno/AlumnoController.ts
46   create src/dao/repository/ProfesorRepository.ts
47   create src/interfaces/dao/IProfesorDao.ts
48   create src/dao/ProfesorDaoImpl.ts
49   create src/models/entities/Profesor.ts
50   create src/interfaces/service/IProfesorService.ts
51   create src/service/ProfesorServiceImpl.ts
52   create src/controllers/Profesor/ProfesorController.ts
53   create src/common/exception/DaoError.ts
54   create src/common/exception/ServiceError.ts
55   create src/index.ts
56
57added 604 packages, removed 328 packages, and audited 730 packages in 41s
58
59101 packages are looking for funding
60  run `npm fund` for details
61
62found 0 vulnerabilities
63-@Mac-Mini-M1 testFolder % npm run dev
64
65> backend@1.0.0 dev
66> npm run generate && ./node_modules/nodemon/bin/nodemon.js
67
68
69> backend@1.0.0 generate
70> tsoa routes && tsoa swagger
71
72[nodemon] 2.0.19
73[nodemon] to restart at any time, enter `rs`
74[nodemon] watching path(s): src/**/*
75[nodemon] watching extensions: ts
76[nodemon] starting `npm start`
77
78> backend@1.0.0 prestart
79> npm run build
80
81
82> backend@1.0.0 build
83> npm run clean && tsc -p tsconfig-build.json
84
85
86> backend@1.0.0 clean
87> rm -rf dist
88
89
90> backend@1.0.0 start
91> node ./dist
92
93connecting to database
94connected to database
95Server started at http://localhost:8080

Example entity model in YAML format

1Alumno:
2 nombre: String
3 apellidos: String
4 edad: Number
5 nota: Number
6Profesor:
7 nombre: String
8 apellidos: String
9 edad: Number

NPM Package

You can check this package too in NPMJS