https://github.com/michaelcurrin/node-project-template

Template for creating Node.js projects including docs and a deploy pipeline
https://github.com/michaelcurrin/node-project-template

beginner ci-cd deploy-pipeline javascript node node-template nodejs quickstart template template-project

Last synced: about 1 month ago
JSON representation

Template for creating Node.js projects including docs and a deploy pipeline

• Host: GitHub
• URL: https://github.com/michaelcurrin/node-project-template
• Owner: MichaelCurrin
• License: mit
• Created: 2020-08-21T21:32:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-21T07:46:29.000Z (8 months ago)
• Last Synced: 2025-03-18T00:37:36.330Z (about 2 months ago)
• Topics: beginner, ci-cd, deploy-pipeline, javascript, node, node-template, nodejs, quickstart, template, template-project
• Language: JavaScript
• Homepage:
• Size: 83 KB
• Stars: 9
• Watchers: 2
• Forks: 31
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node Project Template

> Starter template for creating a Node.js project including docs and a deploy pipeline

[![Node CI](https://github.com/MichaelCurrin/node-project-template/workflows/Node%20CI/badge.svg)](https://github.com/MichaelCurrin/node-project-template/actions?query=workflow:"Node+CI")

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/node-project-template)](https://github.com/MichaelCurrin/node-project-template/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![Made with Node](https://img.shields.io/badge/dynamic/json?label=node&query=%24.engines%5B%22node%22%5D&url=https%3A%2F%2Fraw.githubusercontent.com%2FMichaelCurrin%2Fnode-project-template/%2Fmaster%2Fpackage.json&logo=node.js&logoColor=white)](https://nodejs.org "Go to Node.js homepage")



      

        

    








[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/node-project-template/generate)



## Preview

_This is a placeholder section for a screenshot of your shiny new web app or CLI tool_.



    



## Sample usage

_TODO: Add just a few lines to show how to use your application - some samples below._

Run with NPX:

```sh

$ npx foo

```

Install and run as a CLI tool:

```sh

$ npm install foo

$ foo --help

```

Use in your JS app:

```javascript

import { foo } from "bar";

foo(123)

```

## Documentation

> How to install, run and deploy this project



    

[![View Project Docs](https://img.shields.io/badge/View-Project_Docs-blue?style=for-the-badge)](/docs/)




See the [Template Notes](/docs/template-notes/) section of the docs for info on this template and how to use it.

## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).