@appfolio/react-gears
    TypeScript icon, indicating that this package has built-in type declarations

    6.12.1 • Public • Published

    react-gears

    react-gears is a React implementation of Appfolio UI components, using React, Bootstrap 4, and reactstrap.

    https://appfolio.github.io/react-gears


    Getting Started

    npm install @appfolio/react-gears
    

    Example

    import React from 'react';
    import { Button } from '@appfolio/react-gears';
    
    export default (props) => {
      return (
        <Button color="danger">Danger!</Button>
      );
    };
    

    Development

    IMPORTANT: Make sure your commits follow conventional commits guidelines!

    Install dependencies:

    npm install
    

    Run storybook examples:

    npm start
    

    Open http://localhost:6006 in browser

    Run tests & coverage report:

    npm test
    

    If using Cypress for integration testing, you can use react-gears-cypress for testing react-gears components.

    Run Linter

    npm run lint
    

    Publishing

    Release PRs are automatcally generated by release-please when new commits are merged to master. When you're ready to publish, just merge the release PR (branch should look like release-v${major}.${minor}.${patch}), pull master, and run npm publish.

    Publishing pre-releases

    Make sure to add a github auth token with package write permissions to your ~/.npmrc file.

    //npm.pkg.github.com/:_authToken=YOUR_TOKEN_HERE
    

    To publish:

    npm version (premajor|preminor|prerelease)
    npm publish:prerelease
    

    Keywords

    none

    Install

    npm i @appfolio/react-gears

    DownloadsWeekly Downloads

    326

    Version

    6.12.1

    License

    MIT

    Unpacked Size

    4.36 MB

    Total Files

    990

    Last publish

    Collaborators

    • appfoliodavidacevedo
    • phwebi
    • appfolio-npm
    • xeger