Skip to content

πŸ› πŸ“¦πŸŽ‰ Generate Node.js boilerplate with optional libraries & tools

License

Notifications You must be signed in to change notification settings

irevenko/forge-node-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

39 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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