michaelcurrin / node-project-template

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

Node Project Template

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

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. Such as a Node CLI or shell snippet.`

$ npm install foo
$ foo --help

import { foo } from "bar";

foo(123)

Documentation

How to install, run and deploy this project

See the Template Notes section of the docs for info on this template and how to use it.

License

Released under MIT by @MichaelCurrin.

node-project-template's Issues

Rename to node-project-quickstart

Handle license

More for other people to use and for other projects

Use link to source license and todo item rather than copying LICENSE-source?

Consider README.template.md

Add docs site

Whether docsify or just simple GH Pages

Pick more content

Use PY project and recent quickstart

Use link to badges
And some useful starter badges

Add link Node GHA workflow

Add sample image placeholder sample.png