create-service-component

Boring Express Microservice Component Generator

Features

Generated component includes the following features:

• Generate full CRUD component (list, create, get, update & delete)
• Auto register the new created component to express routes

Install

Make sure yeoman is installed

$ yarn global add yo

Then install the generator

$ yarn global add generator-create-service-component

Usage

Navigate to the created service (using @boringcodes/create-service) root dir and run the following command to generate new component

$ yo create-service-component

# or :with-mongo
$ yo create-service-component:with-mongo

# or :with-postgres-sequelize
$ yo create-service-component:with-postgres-sequelize

# or :with-postgres-typeorm
$ yo create-service-component:with-postgres-typeorm

# or :with-postgres-prisma
$ yo create-service-component:with-postgres-prisma

This scaffolds out:

├── src
│   ├── components
│   │   ├── component-names
│   │   │   ├── constants.ts
│   │   │   ├── controller.ts
│   │   │   ├── index.ts
│   │   │   ├── model.ts        (:with-mongo/:with-postgres-sequelize/:with-postgres-typeorm)
│   │   │   ├── repository.ts   (:with-mongo/:with-postgres-sequelize/:with-postgres-typeorm/:with-postgres-prisma)
│   │   │   ├── types.ts
│   │   └── ...
│   ├── ...
├── ...

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Authors

BoringCodes

License

MIT