Automating My Node.js Setup with notsc 🦉

How do we start?...

A year ago, around this time, I published a blog post on how to set up a Node.js project with Typescript support.

Setting up a Node.js Express project with Typescript

Cedric Ahenkorah ・ Aug 2 '24

#node #softwareengineering #typescript #express

At the time, I just wanted a place to reference the steps I normally go through when scaffolding a new backend project with Nodejs and Typescript. Writing that blog post felt like the best way to keep this knowledge organized and share that it with anyone else who may find it helpful.

I got a few views on that post, and while I never really knew how useful it was to others, one moment stood out: at one dev meetup last year (Code and cocktails), a friend introduced me to someone who had found that post very helpful. It felt really great that something I put out based of my own pain points (googling the right steps, config set up and etc) in setting up a new Nodejs backend project made someone else's life a bit easier.

A year on and I still reference this blog post myself each time I want to scaffold a new backend project. But, honestly, I've grown tired of reading it each time and repeating the same setup tasks - adding logging, setting up a database, configuring redis, defining standard API responses and so on. It's tedious, and I don't have them memorized. So I asked myself, how can I make this easier? Ideally I should be able to "one shot" a new backend project with Node.js with TS support, and with all the tools and config I usually set up manually. After some research, I settled on building a CLI tool that does this for me.

Meet Notsc🦉
A simple CLI tool that scaffolds up my Node.js with Typescript support backend project in a few seconds and includes the boilerplate config I typically need. No more referencing my own blog post loool. It's opinionated, clean and fast. But yeah, that's the beauty of engineering, there's always a new / better way to do something or solve a problem. I'll be using this CLI tool myself anytime I need to set up my backend projects, and you can too. To get started, run this command to install the CLI globally on your machine and watch it do the magic for you.

notsc - npm

A highly configurable boilerplate generator to kickstart a Node.js + TypeScript API project with ease. Latest version: 1.1.0, last published: 20 hours ago. Start using notsc in your project by running `npm i notsc`. There are no other projects in the npm registry using notsc.

npmjs.com

npm install -g notsc

Now installed, all you need to do is run it and follow the prompts:

notsc

You should be able to scaffold a new Node.js with Typescript support backend project this way.

This is an open source project and I'd love your contributions, support and feedback.

cedricahenkorah / notsc

nodejs backend boilerplate with typescript support

notsc 🦉

notsc is a highly customizable boilerplate generator for quickly scaffolding Node.js + TypeScript API projects. It supports optional integrations like database setup, Swagger/OpenAPI documentation, Redis, Jest for testing, and Docker—so you can start building with the tools you need, right out of the box.

🚀 Features

• ✅ TypeScript support
• 🧱 Modular architecture (controllers, routes, services)
• 📦 Optional features: database, Swagger, Redis, Jest, Docker
• 🎯 ESLint + Prettier setup
• 🔁 Nodemon for development
• 🧪 Jest for testing (optional)
• 🌐 Swagger/OpenAPI setup (optional)
• 🐳 Dockerfile & Dockerignore (optional)
• 📂 Environment variable management

---

📦 Installation & Usage

Using the Published Package

Quick Start

npx notsc my-app

Global Installation

npm install -g notsc
notsc my-app

With Package Managers

# Using yarn
yarn create notsc my-app

# Using pnpm
pnpm create notsc my-app

Local Development

Clone and Setup

# Clone the repository
git clone <your-repo-url>
cd notsc
# Install dependencies
npm

…

View on GitHub

Until next time. I should definitely be writing more often, this was fun!🙂