/forge-node-app

๐Ÿ› ๐Ÿ“ฆ๐ŸŽ‰ Generate Node.js boilerplate with optional libraries & tools

Primary LanguageTypeScriptMIT LicenseMIT

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