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

    0.0.32 • Public • Published

    React-UI

    React UI is a very opinionated design library, that is based on React and TailwindCSS. The build in theming solution, allows you to change the look and feel of all components.

    Discover futher details about this design library on our homepage.

    Table of content

    Usage

    First, you have to install the package:

    npm install @aboutbits/react-ui
    

    Further documentation of each component can be found here.

    Contribute

    These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

    Prerequisites

    Setup

    Install all dependencies by executing the following command:

    npm install

    Next, you can start the application:

    npm run dev

    The project will be served at http://localhost:4000.

    Generate a static build by executing the following command:

    npm run build-storybook

    Learn more

    To learn more about Storybook, take a look at the following resource:

    Development

    For linting the source files, execute the following command:

    npm run lint
    
    # or
    
    npm run lint:fix

    For running the tests, execute the following command:

    npm run test
    
    #or
    
    npm run test:watch

    Docker Environment

    If you want to get up and running without installing all special requirements of the project locally on your machine, you can follow these steps to set up a preconfigured Docker environment.

    This environment has also the advantage, that it serves the application with a custom domain name and through HTTPS with valid SSL certificate.

    Prerequisites

    Setup

    Install all dependencies by executing the following command:

    docker-compose run --rm node npm install

    To start the Docker containers, execute the following command:

    docker-compose up --detach
    
    # or if you want to force a rebuild of the containers
    
    docker-compose build --pull
    docker-compose up --detach

    The project will be served at https://web.aboutbits.test.

    Afterwards, you can stop the containers using the following command:

    docker-compose stop
    
    # or if you want to stop and delete the containers
    
    docker-compose down

    Build & Publish

    To build and publish the package, simply commit all changes and push them to master. Then run one of the following commands locally:

    npm version patch
    npm version minor
    npm version major

    Information

    About Bits is a company based in South Tyrol, Italy. You can find more information about us on our website.

    Support

    For support, please contact info@aboutbits.it.

    Credits

    License

    The MIT License (MIT). Please see the license file for more information.

    Keywords

    none

    Install

    npm i @aboutbits/react-ui

    DownloadsWeekly Downloads

    223

    Version

    0.0.32

    License

    none

    Unpacked Size

    218 kB

    Total Files

    277

    Last publish

    Collaborators

    • aboutbits_tech