1.0.0 • Published 3 years ago

@matejbransky/react-lib v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

react-lib template

A basic React+TS repository with Conventional Commits and GitHub Actions workflow configuration to achieve fully automated package publishing to the NPM registry. As a bonus Renovate bot keeps dependencies up to date.

Features:

  • code quality tools (Prettier, ESLint)
  • TypeScript
  • React
  • unit tests with Jest
  • demo app
  • Github Actions (test, release)
  • conventional commits (commitlint in precommit hook, semantic release)
  • UMD, ES bundles
  • deployment of demo app with Vercel

Create a new repository from this template

Click the Use this template button and provide the new repository details.

Getting Started

Let's start by setting up the new repository:

  1. To perform authenticated operations against the npm registry in your workflow, you'll need to store your npm authentication token as a secret NPM_TOKEN. For more information, see "Creating and using encrypted secrets." (source)

  2. Update:

    • LICENSE (author name)
    • README.md (short description, getting started, installation),
    • package.json (attributes: name, url, author, main, module, exports),
    • vite.config.ts (build.lib.name and external dependencies),
    • demo app,
    • tests

How it works

Each push to main branch will generate a version number, git tag, Conventional Changelog, release commit, pushing changes to the origin and publish to the NPM registry.