irevenko / forge-node-app

🛠📦🎉 Generate Node.js boilerplate with optional libraries & tools

forge-node-app 🛠📦🎊

A Fast Way to Generate Node.js Boilerplate With Your Favorite Development Tools and Libs

💖 Inspired by vue-cli

Usage 🛴

Run

npx forge-node-app

Or install globally

npm i -g forge-node-app
forge-node-app

Preview 🔍

Supported Things 📄

• VanillaJS, TypeScript, Babel
• npm, yarn
• ESLint, Prettier
• dotenv, nodemon, ts-node-dev
• Jest, Mocha + Chai
• git repo (GitHub, GitLab)

Additonal Stuff 📜

• Setting up Initial Folders (src, tests)
• Setting up Initial Files (index, index.test)
• Initing the package, Setting up Scripts and Package Details
• Generating LICENSE, README, .gitignore, prettier and linter configs, babel and ts configs
• Providing compatibility for all libraries with TS/Babel

Contributing 🤝

Contributions, issues and feature requests are welcome!
Feel free to check issues page

Quick start 🚀

Clone the repo
npm install
npm run build && npm start

Tech stack 📜

• TypeScript + ESLint(AirBNB) + Prettier
• Inquirer for the interface
• chalk for terminal colors
• ora for cli spinners
• license for LICENSE generation

ToDo 🧾

• More libs (JSDoc, Process Managers, Loggers)
• Add yargs

What i Learned 🧠

• Building CLI with Inquirer, ora, chalk
• TypeScript & Babel basics
• How to setup Modern Node.js Project
• ESLint, Prettier, tsconf structures
• How npm and yarn work
• Setting up simple Unit tests with Jest, Mocha + Chai
• Writing package manager scripts
• Publishing npm package

License 📑

(c) 2020 Ilya Revenko. MIT License

forge-node-app's Issues

Adding Code of conduct

Would recommend add code of conduct to your repo for better opensource. For more information have a look the docs link here.

https://docs.github.com/en/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project

[Integration Request] Add commitlint

Could you please add commitlint option