Git Product home page Git Product logo

boilerplate-package-vite-react's Introduction

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

npm version Build Status License HitCount

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. Alt text

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

NPM

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! ๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰

boilerplate-package-vite-react's People

Contributors

savanesoff avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.