Skip to content

onebeyond/cuckoojs

Repository files navigation

logo

Let the cuckoo accommodate the nest for you.

CuckooJS is a scaffolding based on NestJS. Inspired by the cuckoo bird, we took advantage of the already created nest and included our own easter eggs, such as:

This way, you don't have to worry about including these when initiating a new project.

logo How to use it

Install the cuckoo cli globally

npm install -g @guidesmiths/cuckoojs-cli

Creating a new NestJS app with the basic tooling:

cuckoo new <projectname>

You can still use all the commands that work with NestJS, for example:

cuckoo generate|g controller <name>

Use our schematics

If you want to use the schematics solely, install the schematics globally

npm install -g @guidesmiths/cuckoojs-schematics

Currently we have schematics for:

  • creating a .gitignore file:
schematics @guidesmiths/cuckoojs-schematics:gitignore --directory=<path>
  • adding commitlint:
schematics @guidesmiths/cuckoojs-schematics:commitlint --directory=<path>