A simple and powerful skeleton to kickstart your next NPM package.
Designed to get out of your way and let you focus on building.
🎯 Comes with built-in setup automation, GitHub workflows, author metadata, and more!
-
Use the template
Click the Use this template button on the GitHub page to create your own repo from this skeleton. -
Clone your new repository
git clone https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git cd YOUR_REPO_NAME -
Run the setup script
npm install npm run setup
-
Answer the prompts, and your package will be tailored to you:
- Package name
- Author info
- GitHub username
- Preferred package manager (
npmorpnpm) - etc.
-
Done!
Your skeleton is now personalized, cleaned up, initialized with Git, and ready to code 🎸
You can even publish to npm with a single GitHub release!
This skeleton comes with a preconfigured GitHub Action to automatically publish your package to npmjs.com whenever you create a GitHub release. 🎉
To enable it:
-
Create an npm access token:
- Go to your npm account tokens page.
- Click "Generate New Token".
- Choose "Automation" (or "Classic" with "Publish" access if you prefer).
- Copy the generated token.
-
Add the token to your GitHub repo:
- Go to your repository on GitHub.
- Navigate to Settings → Secrets and variables → Actions → New repository secret.
- Name it exactly:
NODE_AUTH_TOKEN - Paste your token as the value.
-
Publish your package:
- Push your changes to
main(or your default branch). - Go to the Releases tab on GitHub.
- Click "Draft a new release" and fill in the version/tag.
- Once published, the GitHub Action will automatically publish your package to npm. 🚀
- Push your changes to
✅ That’s it! Now your releases will sync directly to npm with no extra steps.
- 🔁 Replaces placeholders with your custom info.
- 🧪 Ready-to-go structure.
- 🔧 GitHub Workflows:
- Auto-assign issues
- Dependabot support
- ✅ Publish to npm on GitHub release (just create a release tag, and it’s live!)
- 📋 GitHub repo enhancements:
- Issue templates for structured bug reports and feature requests.
- Pull Request templates to encourage clear and detailed contributions.
- 🧹 Auto-cleans stub files and setup script after running.
- 💡 Package manager-based CI workflows (only keeps the one you need!).
Creating a new NPM package can be a chore:
- Configure GitHub flows ✅
- Clean project structure ✅
- Automate publishing ✅
Let this repo do all the boring stuff, so you can jump straight into the code.
This is just the beginning.
There’s so much room to grow — from better GitHub automations (issue bots, release helpers) to richer setup options.
If you’ve got ideas, open a pull request or start a discussion — contributions are super welcome! 🌱
If this helped you out, please consider giving the repo a ⭐️ on GitHub — every bit of support means a lot!
