Skip to content

Publish to npm Registry #49

@Josephat-S

Description

@Josephat-S

What to build

Prepare the package for publishing to npm so users can run npx opusify create. This includes updating package.json metadata, adding a .npmignore, and setting up a publish workflow.

Files to create/modify

  • package.json (add description, keywords, author, files field)
  • .npmignore (Create — exclude templates from npm package since they're fetched from GitHub)
  • .github/workflows/publish.yml (Create — publish on tag push)

Specs

  • The npm package should be lightweight — templates are fetched from GitHub at runtime (production mode).
  • Only include: index.js, src/, package.json, README.md, LICENSE.
  • Publish workflow triggers on v* tags.

Acceptance criteria

  • package.json has proper metadata (description, keywords, author, license, repository).
  • .npmignore excludes templates/, node_modules/, test files, .github/.
  • npm pack produces a tarball under 50KB.
  • GitHub Action publishes to npm on version tag.
  • npx opusify create works after publishing (fetches templates from GitHub).

Dependencies

  • All template issues should be complete first.

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions