Skip to content

A bare-bones project template for Node.js projects with some of the tooling that I like to use with Node projects.

License

Notifications You must be signed in to change notification settings

kevinoid/node-project-template

 
 

Repository files navigation

Project Template

Build Status Coverage Dependency Status Supported Node Version Version on NPM

A Node.js/npm project template with codecov, coveralls, ESLint, conventional-changelog, c8, JSDoc, and mocha.

It is the template that I am using for my own Node.js projects, which represents my current preferences. I am not advocating for these choices nor this template specifically, although I am happy to discuss or explain any choices made herein. It is being published both for my own convenience and in case it may be useful to others with similar tastes.

Introductory Example

Features

Installation

This package can be installed using npm, either globally or locally, by running:

npm install @kevinoid/project-template

Recipes

More examples can be found in the test specifications.

API Docs

To use this module as a library, see the API Documentation.

Contributing

Contributions are appreciated. Contributors agree to abide by the Contributor Covenant Code of Conduct. If this is your first time contributing to a Free and Open Source Software project, consider reading How to Contribute to Open Source in the Open Source Guides.

If the desired change is large, complex, backwards-incompatible, can have significantly differing implementations, or may not be in scope for this project, opening an issue before writing the code can avoid frustration and save a lot of time and effort.

License

This project is available under the terms of the MIT License. See the summary at TLDRLegal.

The template upon which this project is based is available under the terms of CC0 1.0 Universal.

About

A bare-bones project template for Node.js projects with some of the tooling that I like to use with Node projects.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •