Skip to content

A template to help you (me) quickly get started with publishing an NPM package

Notifications You must be signed in to change notification settings

123ishaTest/ts-library-template

Repository files navigation

NPM Package Template

A template to help you (me) quickly get started with publishing an NPM package

Uses TypeScript, Vite, Vitest, Prettier

Usage

Create from a GitHub template

Add the top of this page on GitHub there should be a large green button that says Use This Template. Click that to use this template!

Change these things in the project

  • Update the package.json.
    • Update the package name and description.
    • Replace anything that says ts-library-template with your package name.
    • Replace anything with that says isha with your name and contact details.
  • Add an environment variable NPM_TOKEN to GitHub actions, so it can publish packages
  • Update the repo name in .changeset/config.json
  • Update the README.
  • Inspect the .github/workflows configuration to see if they work with your GitHub setup.
  • Update your Prettier settings and don't complain about my preferences :)
  • Make something cool!

About

A template to help you (me) quickly get started with publishing an NPM package

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •