Overview

Bido means Start in Igbo Language. With Love ❤️ from Biafra.

Starter project for Node.js applications using TypeScript with test, lint, code formatter already configured. Check the tooling section for more details. The preferable way to use this boilerplate is using npx command. You can use npm init too. Use the following commands to bootstrap a new project:

NPX

npx bido-nodejs-package-toolkit --app=your-app

NPM Init

npm init bido-nodejs-package-toolkit --app=your-app

Bido Global Installation

Fisrtly, Install the Toolkit Globally and then simply run the CLI command whenever you want to start a new project.

npm -g i bido-nodejs-package-toolkit

then,

bido --app=your-app 

Without parameters, the project will be created on a folder my-app in the same directory where you executed the command. All parameters available:

--destination=<FOLDER_DESTINATION> Defaults to the current directory
--app=<APP_NAME> Defaults to my-app

The final folder will the parameter destination, if provided, concatenated with the parameter app.

ESM

The project template now uses ESM by default.

Docker

Minimalist docker image generation. Check this Dockerfile.

Local Dev Environment

Run make up to spin up a local environment with Docker Compose. Check this docker-compose.yml for more details.

Tooling

• ESM
• TypeScript
• Jest
• EsLint
• Husky
• Commit Lint
• Lint Staged
• Prettier
• Nodemon
• Docker | Docker Compose

Credits

This project is adapted from Create Nodejs TS by @vitorsalgado and minor contributions from typescript-npm-package-template by @ryansonshine and then updated to latest dependency versions and technical debts fixes by @zaghadon and Topazdom Technologies Limited. Thanks to all contributors.

License

This project is MIT Licensed.