Skip to content

shubhranshu/nodejs-starter-template

Repository files navigation

NodeJs CLI Starter template

Starter template to get going ith NodeJs CLI development without much fuss.

Branch
develop Build Test
master Build Test

Configured tooling

  • ES6 support with babel
  • Test script with Ava
  • Watch scripts for run and tests
  • Babel, Prettier and Eslint configs
  • Github Actions for build and test

Usage and Configuration

Using this template to initialise repository or copy the files as required. Or simply use it to get some inspiration.

Scripts

  • build : Build the project and copy the built files to dist folder
  • test : Run ava tests
  • watch-test : Watch code and run tests on code change
  • cli-run : Run the code without building
  • watch-run : Use nodemon to watch code and run on change

Packages

We are using npm as the default package manager. To use Yarn delete package-lock.json and run yarn

Dev dependencies

To Do

  • Being able to parameterise the setup
  • Options for Test framework
  • CLI setup without using the repository