by Protosus

Starter template for React library development with Vite

Starter template for React library development with Vite. Pull it as your starting point, then change your origin to point to actual repo.

Features

Readme badges

Packaging

• Uses pnpm for faster install using smart caching
• Public type module
• Vite dev server and toolkit and
• Dev dependencies for testing and development
  • vitest
  • eslint
  • react
  • typescript
  • and more...
• changesets for changelogs and auto-release workflow
• Exports definitions for index and types
• Files definition for npn package release
• gh-pages for publishing demos if needed

Scripts

• build
• test
• release ...

Testing

Uses vitest. Simply tun test command

GH Workflows

• pr unit tests with caching
• main branch npm auto publishing

NOTE
Be sure to add NPM_TOKEN secret in you GH repository under: settings/secrets/actions.
You need to generate a classic access token for Automation under: https://www.npmjs.com/settings/.../tokens/

NOTE
Enable GH repo workflow permissions to Read and write permissions under: settings/actions/general This will enable changeset to auto-version your package.

License

• MIT included ini package as well

--- DOCS Examples ---

Installation

To install Overdrag, use npm or yarn:

npm install boilerplate-package-vite-react

or

yarn add boilerplate-package-vite-react

or

Usage

Import the Overdrag Rect component:

import MyComponent from "boilerplate-package-vite-react";

Component

Render component anywhere in you app:

function App() {
  return (
    <MyComponent
      /* optional props */
      style={{ backgroundColor: "red" }}
    />
  );
}

Properties

• example Special property

Events

The available events are:

• example: Special events

Description

This is a detail description of your component

PS

Hit me up on Li

Enjoy! 🎉🎉🎉