NestJS Library Template Configuration

CONFIGURE_TEMPLATE.md

🐣 Previous steps

1. Use this template

2. Name your repository

📦 🚀 CI/CD Configuration

In order to configure successfully this template for CI/CD carry out the following steps:

Secrets:

• Create NPM_TOKEN
• Create GH_TOKEN
• Create CODECOV_TOKEN ⚠️ Codecov Action seems be broken nowadays

💡 GH_TOKEN should have repo permissions

🔧 Initial Setup

You can configure this template running setup script:

# Navigate to your reposirory directory
cd your-template-repository/

# Install setup dependences
npm install inquirer replace-in-file

# Run setup
# You can run it in dry mode using `--dryRun` flag
sudo node tools/setup.js

# Install dependences (in order to generate your package-lock.json)
npm install

💡 If the process success, remove tools/setup.js file & the advise on README.md

📦 Publish

You are ready to publish 😼

Just stash your changes and run:

# Commit with commitizen CLI
git cz
# Push changes
git push

All right! Your repository should look like this: