https://github.com/performant-software/react-components
A library of shared React components
https://github.com/performant-software/react-components
react storybook
Last synced: 3 months ago
JSON representation
A library of shared React components
- Host: GitHub
- URL: https://github.com/performant-software/react-components
- Owner: performant-software
- License: mit
- Created: 2020-05-08T19:57:44.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-02-12T20:06:33.000Z (5 months ago)
- Last Synced: 2026-02-13T03:52:08.846Z (5 months ago)
- Topics: react, storybook
- Language: JavaScript
- Homepage: https://performant-software.github.io/react-components/
- Size: 143 MB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-components
A library of shared React components.
## Requirements
Node (16.14.x)
## Development
### Installation
```
yarn install
```
### Building
```
cd packages/ && yarn build
```
### Storybook
Set environment variables in `./packages/storybook/.env`. **Note:** the `TRANSLATE_URL` environment variable is required to build/start Storybook.
Running storybook
```
yarn storybook
```
Building the static site
```
yarn build-storybook
```
## Production
package.json
```json
{
"name": "my-awesome-project",
"dependencies": {
"@performant-software/semantic-components": "^1.0.0"
}
}
```
MyComponent.js
```javascript
import { ListTable } from '@performant-software/semantic-components';
const MyComponent = (props) => (
);
```
## Beta
Sometimes it may be necessary to test your consuming application prior to creating a release. For example, you just added a new component and want to test it out in the application to make sure everything looks and works as expected.
For this we can use NPM's "beta" tags. This will allow the compiled code to be added as a dependency from NPM, but will not map to the "latest" release for production.
Let's say the current version number is "0.5.15". You can update the version in `react-components.json` to "0.5.16-beta.0" and publish the package(s) to NPM via:
```
yarn publish-beta
```
Then, in your consuming application, update your dependencies as follows:
```json
{
"dependencies": {
"@performant-software/semantic-components": "0.5.16-beta.0",
"@performant-software/shared-components": "0.5.16-beta.0"
}
}
```
After all testing has passed, create your release of `0.5.16`. See publishing below.
## Publishing
Each of the versions of the individual packages will be kept in sync. The following steps should be taken when publishing a new version of these packages.
1. Update the version in `react-components.json`. See Semantic Versioning Guide below to determine the new version.
2. From the project root, run `yarn publish-release`.
3. Commit your changes and create a PR into the `master` branch. Wait until your PR is merged to proceed.
4. Create a [release](https://github.com/performant-software/react-components/releases) in GitHub. Be sure to note any breaking changes, new features, and bug fixes
5. In GitHub update the "next release" label to "". This will allow us to go back and see exactly which PRs were included in each release.
6. Create a new "next release" label in GitHub.
### Semantic Versionsing Guide
- **Major:** `1.2.3 -> 2.0.0` Many breaking changes, new UI library, new package
- **Minor:** `1.2.3 -> 1.3.0` API changes, many new components, large bug fixes
- **Patch:** `1.2.3 -> 1.2.4` Bug fixes, new components