Skip to main content

New Project Setup

Methods

You can use this template using 2 methods.

Using Github GUI

If you using Github GUI 🖥️ to initiate your project, consider following this github doc.

Using Git CLI

Git CLI 🔮 users, focus here:

# head to your workspace
cd to/your/favourite/directory/on/the/system

# clone the template
git clone https://github.com/squareboat/nestjs-boilerplate your-project

After Clone Steps

# go to the directory where the clone happened
cd to/your/project

# now, let's install the dependencies
npm install

# run the build command to prepare our cli commands
npm run build

# now, run the following command to delete all unncessary files and create a fresh git repo
node cli init

# Boom 💥 and it is done!