Latest (recommended) Beta: Alpha:

npm-module-blanky

Opinionated boilerplate used to make and deploy npm modules.

Goals of this project

• Contain configuration files to setup all tools I tend to use in my development flow.
• Clone, rename some files, and get developing!
• Start with zero dependencies. I try my best to keep all npm modules as slim as possible.
• Setup with continuous delivery to npmjs.com.
• Publish source maps and Typescript type declarations.

Getting started

• Enable GitHub Actions for your repository.
• If you have not done so already, create a GitHub account for bot purposes.
• Add your bot account in the repository /settings/access.
• Create secrets in GitHub settings:
  • BOT_PUSH_TOKEN with key being a GitHub personal access token with push permission so the bot can push to the repository (the bot will be making git tags and releases on repository).
  • CODECOV_TOKEN with upload token for CodeCov project to upload test coverage report to codecov.
  • NPM_TOKEN token to push npm module to your npm account.
• Edit the codecov badge at the top of this file. Find the token for the badge at https://app.codecov.io/gh/<github-username>/<name-repo>/settings/badge
• Project is setup for public publishing by default. If you would like to make your module private, edit publishConfig in package.json.
• Delete CHANGELOG.md to reset it.

Contributors

Thanks goes to these wonderful people (emoji key)

Levi Bostian 💻 📖 🚧