Skip to content

A template repo to set up your NodeJS library project

License

Notifications You must be signed in to change notification settings

chaoyangnz/node-library-template

Repository files navigation

Sponsor NPM version TypeScript version Node.js version Build Status - GitHub Actions

node-library-template

👩🏻‍💻 Developer Ready: An easy-to-start template to speed up building your NodeJS library.

🏃🏽 Instant Value: All basic tools included and configured:

  • TypeScript 4.2
  • ESLint with some initial rules recommendation
  • Jest for fast unit testing and code coverage
  • Type definitions for Node.js and Jest
  • Prettier to enforce consistent code style
  • NPM scripts for common operations: test, release
  • Simple example of TypeScript code and unit test
  • .editorconfig for consistent file format
  • Environments management via Volta
  • Example configuration for GitHub Actions

Getting Started

Make sure to be used with the latest Active LTS release version of Node.js.

Use as a repository template

Click the Use template link (or the green button). Now start adding your code in the src and unit tests with *.spec.ts.

Clone repository

To clone the repository use the following commands:

git clone https://github.com/chaoyangnz/node-library-template
cd node-library-template
npm install

Download latest release

Download and unzip current master branch or one of tags:

wget https://github.com/chaoyangnz/node-library-template/archive/master.zip -O node-library-template.zip
unzip node-library-template.zip && rm node-library-template.zip

Available Scripts

  • clean - remove coverage data, Jest cache and transpiled files,
  • build - transpile TypeScript to ES6,
  • build:watch - interactive watch mode to automatically transpile source files,
  • lint - lint source files and tests,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests
  • release - bump the version, commit, create release tag and publish to NPM registry

License

Licensed under the MIT. See the LICENSE file for details.

About

A template repo to set up your NodeJS library project

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published