Skip to content
Selwyn edited this page May 30, 2023 · 2 revisions

Open Source Project

Repository template with files to get started on an Open Source project.

Getting started

  1. Create a new repository using this repository as a template and ☑️ include all branches.
  2. Clone the new repository and choose a starting point from the branches, for example: git switch nodejs.
  3. Start with a clean git state: rm -r .git & git init.
  4. Go through the files replacing information with your project specifics.
  5. git commit & git push --force 🎉

Branch specifics

Node.js package

The nodejs-package branch contains a publish workflow to automatically publish the npm package. To setup the token:

  1. Create an access token for your package:
    • Log into npmjs.com with De Voorhoede account.
    • Open https://npmjs.com/settings/$USERNAME/tokens/granular-access-tokens/new.
    • Use the package name for the token name, a long expiry, 'Read and write' permissions, and pick the specific package that you're publishing.
  2. Add your token as a secret for your project's GitHub Actions
    • Open https://github.com/$USERNAME/$REPO/settings/secrets/actions/new.
    • Set NPM_PUBLISH_TOKEN as the name.
    • Set the npm token from the previous step as the value.
  3. In the npm package's settings https://www.npmjs.com/package/$PACKAGE_NAME/access, allow publish without 2FA for granular/automation tokens only.
Clone this wiki locally