https://github.com/onebeyond/cuckoojs

A NestJS based template builder with some extras
https://github.com/onebeyond/cuckoojs

hacktoberfest nestjs

Last synced: about 2 months ago
JSON representation

A NestJS based template builder with some extras

• Host: GitHub
• URL: https://github.com/onebeyond/cuckoojs
• Owner: onebeyond
• License: mit
• Created: 2022-06-14T14:50:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-09T09:20:44.000Z (11 months ago)
• Last Synced: 2024-10-12T18:14:45.838Z (3 months ago)
• Topics: hacktoberfest, nestjs
• Language: TypeScript
• Homepage:
• Size: 1.14 MB
• Stars: 8
• Watchers: 5
• Forks: 0
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


  










#### 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:

- Commitlint

- Husky

- License checker 

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

###   How to use it

Install the cuckoo cli globally

```bash

npm install -g @guidesmiths/cuckoojs-cli

```

Creating a new NestJS app with the basic tooling:

```bash

cuckoo new 

```

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

```bash

cuckoo generate|g controller 

```

### Use our schematics

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

```bash

npm install -g @guidesmiths/cuckoojs-schematics

```

Currently we have schematics for:

- creating a .gitignore file:

```bash

schematics @guidesmiths/cuckoojs-schematics:gitignore --directory=

```

- adding commitlint:

```bash

schematics @guidesmiths/cuckoojs-schematics:commitlint --directory=

```