@aboutbits/react-ui

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 further details about this design library on our homepage.

Table of content

• Usage
• Contribute
  • Learn more
  • Development
• Build & Publish
• Information

Usage

First, you have to install the package:

npm install @aboutbits/react-ui

You can use the tailwind-preset.js file as preset in your project's tailwind.config.jsto load the default colors.

Further documentation of each component can be found here.

Hint: If you're using Next.js or Webpack in your project, you can use the ReactUI integrations to easily integrate ReactUI.

Contribute

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

Prerequisites

• NPM

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:

• StoryBook Documentation

Development

For linting the source files, execute the following command:

npm run lint

# or

npm run lint:fix

For type checking, execute the following command:

npm run typecheck

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

• Docker / Docker for Mac / Docker for Windows
• Docker Compose
• Local Docker Environment

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, visit the GitHub Actions page of the repository.

You can choose between two workflows:

• Release Package to publish a new version of the package.
• Pre-Release Package to publish a new pre-release version of the package.

Note: Pre-releases need to be supplied with a pre-id.

Note: To increment a pre-release, you have to run the normal release workflow and select "prerelease". For this action you need to already be on a pre-release version.

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 [e-mail].

Credits

• All Contributors

License

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