https://github.com/netlify/node-template

Netlify's Node.js repository template
https://github.com/netlify/node-template

Last synced: 17 days ago
JSON representation

Netlify's Node.js repository template

• Host: GitHub
• URL: https://github.com/netlify/node-template
• Owner: netlify
• Created: 2020-11-06T16:34:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T03:05:01.000Z (6 months ago)
• Last Synced: 2024-04-11T15:58:48.529Z (5 months ago)
• Language: Python
• Size: 1.09 MB
• Stars: 13
• Watchers: 4
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# node-template

This is a GitHub [cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/installation.html) template for Netlify Node.js repositories.

Please feel free to use this template when starting a new Node.js repository.

## Setup

- `cookiecutter gh:netlify/node-template`

- Create a GitHub repository and push the generated local repo

### Release please setup

We use [release please](https://github.com/google-github-actions/release-please-action) to automate release publishing.

For the `release-please.yml` GitHub workflow to work you'll need to add 3 secrets to your repo:

1. `TOKENS_PRIVATE_KEY` - a GitHub app private key

2. `TOKENS_APP_ID` - a GitHub app id

3. `NPM_TOKEN` - an `npm` automation token

The GitHub app is used to generate GitHub tokens to and should be installed on the repo and have `Contents` and `Pull requests` read & write permissions.

You can create a new GitHub app by visiting `https://github.com/organizations//settings/apps/new`

> It's useful to add those secrets at an organization level instead of at the repo level

## Contributors

Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to set up and work on this repository. Thanks

for contributing!