https://github.com/lixelv/npm-package-template

Npm package template with integrated CI/CD on release
https://github.com/lixelv/npm-package-template

cicd github-workflows npm npm-lib svelte svelte-lib

Last synced: about 1 month ago
JSON representation

Npm package template with integrated CI/CD on release

• Host: GitHub
• URL: https://github.com/lixelv/npm-package-template
• Owner: lixelv
• License: mit
• Created: 2025-03-31T15:53:47.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-31T16:28:54.000Z (about 1 year ago)
• Last Synced: 2025-07-06T09:56:26.987Z (11 months ago)
• Topics: cicd, github-workflows, npm, npm-lib, svelte, svelte-lib
• Language: JavaScript
• Homepage:
• Size: 38.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# npm package template

[![GitHub Workflow Status](https://img.shields.io/badge/CI/CD-Automated-success?style=flat-square&logo=github)](https://github.com/features/actions)

[![Svelte](https://img.shields.io/badge/Svelte-Ready-FF3E00?style=flat-square&logo=svelte&logoColor=white)](https://svelte.dev/)

[![npm](https://img.shields.io/badge/npm-package-CB3837?style=flat-square&logo=npm)](https://www.npmjs.com/)

A streamlined template for creating npm packages with automated CI/CD pipeline. Built with Svelte but can be used for any JavaScript/TypeScript package.

## Features

- Automated publishing to npm on GitHub releases

- TypeScript support out of the box

- Svelte integration (optional for your package consumers)

- Pre-configured testing with Vitest

- TailwindCSS for styling development environment

## Setup Guide

1. **Create a new repository** from this template

2. **Configure your package**

   - Update `package.json` with your package name

   - Version is automatically set from GitHub release tags

   - Modify dependencies as needed for your project

3. **Set up CI/CD**

   - Generate an npm token: [Get npm token](https://www.npmjs.com/settings//tokens)

   - Add token as `NPM_TOKEN` in GitHub secrets: [Create GitHub secret](https://github.com///settings/secrets/actions)

   - Replace ``, ``, and `` with your actual values

4. **Release your package**

   - Create a GitHub release with a semantic version tag (e.g., `v1.0.0`)

   - The workflow automatically builds and publishes your package to npm

---



  npm install your-package-name