@aboutbits/react-ui 中文文档教程
React-UI
React UI 是一个非常自以为是的设计库，它基于 React 和 TailwindCSS。 内置主题解决方案允许您更改所有组件的外观。
在我们的主页 上了解有关此设计库的更多详细信息。
Table of content
Usage
首先，您必须安装软件包：
npm install @aboutbits/react-ui
可以在此处 找到每个组件的更多文档。
Contribute
这些说明将让您在本地计算机上启动并运行项目的副本以进行开发和测试 目的。
Prerequisites
Setup
通过执行以下命令安装所有依赖项：
npm install
接下来，您可以启动应用程序：
npm run dev
该项目将在 http://localhost:4000 提供服务。
通过执行以下命令生成静态构建：
npm run build-storybook
Learn more
要了解有关 Storybook 的更多信息，请查看以下资源：
Development
要检查源文件，请执行以下命令：
npm run lint
# or
npm run lint:fix
要运行测试，请执行以下命令：
npm run test
#or
npm run test:watch
Docker Environment
如果您想获取无需在本地机器上安装项目的所有特殊要求即可启动并运行，您可以按照以下步骤设置预配置的 Docker 环境。
此环境还有一个优势，即它使用自定义域名并通过具有有效 SSL 证书的 HTTPS 为应用程序提供服务。
Prerequisites
Setup
通过执行以下命令安装所有依赖项：
docker-compose run --rm node npm install
要启动 Docker 容器，请执行以下命令：
docker-compose up --detach
# or if you want to force a rebuild of the containers
docker-compose build --pull
docker-compose up --detach
该项目将在 https://web.aboutbits.test 上提供服务。
之后，您可以使用以下命令停止容器：
docker-compose stop
# or if you want to stop and delete the containers
docker-compose down
Build & Publish
要构建和发布包，只需提交所有更改并将它们推送到 master。 然后在本地运行以下命令之一：
npm version patch
npm version minor
npm version major
Information
About Bits 是一家位于意大利南蒂罗尔的公司。 您可以在我们的网站上找到更多关于我们的信息。
Support
如需支持，请联系 info@aboutbits.it。
Credits
License
麻省理工学院许可证（麻省理工学院）。 请参阅许可文件了解更多信息。
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.
