Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/macpaw/macpaw-ui
UI Kit for MacPaw Web Projects
https://github.com/macpaw/macpaw-ui
frontend react ui-kit
Last synced: about 14 hours ago
JSON representation
UI Kit for MacPaw Web Projects
- Host: GitHub
- URL: https://github.com/macpaw/macpaw-ui
- Owner: MacPaw
- Created: 2020-06-16T13:47:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-04T09:26:57.000Z (12 days ago)
- Last Synced: 2024-11-11T21:53:17.354Z (5 days ago)
- Topics: frontend, react, ui-kit
- Language: TypeScript
- Homepage: https://ui.macpaw.com/
- Size: 3.04 MB
- Stars: 31
- Watchers: 9
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# macpaw-ui
## Installation
Install with npm:
```bash
npm install --save @macpaw/macpaw-ui
```
or with yarn:
```bash
yarn add @macpaw/macpaw-ui
```
And import stylesheets manually:
```jsx
import '@macpaw/macpaw-ui/lib/ui.css';
```
## Adding new Component
- Add Component's JSX and styles to [src/%ComponentName%](/src) directory
- Import Component's JS, styles to [ui.js](/src/ui.js) and [ui.scss](/src/ui.scss) correspondingly
- Add document page in `/pages/%component-name%.mdx`
## Adding new Icons
- All common icons should have size 24x24px and dynamic (not hard-coded) `fill` attribute (so it can be changed / overridden later is CSS or React component)
- Add new SVG file icon to `src/Icons/svg/%name%_icon.svg`
- Run `yarn icons` CLI command
## Requirements
- Node 20+
- npm 7+ (lock file v2)
## Library Release Process
Our library release process is designed to ensure quality, consistency, and proper versioning. The process is broken down into multiple stages to ensure every change is tracked, reviewed, and integrated appropriately.
We use [changesets](https://github.com/changesets/changesets) for version and release management.
### 1. Adding Changes
Whenever you introduce a new change, run the command:
> You have to do this at least once per branch with some changes.
```bash
npm run changes:add
```
- The CLI will prompt you with questions regarding your changes. You'll need to specify the nature and level of the changes (options: patch, minor, major).
- After completing the CLI prompts, commit the changes with a commit message similar to `chore: update changesets`.
### 2. Releasing and Publishing
Steps to make a release:
- To initiate a release, create a pull request from `master`` to release with the title Release.
- Ensure all CI checks pass successfully.
- Once CI checks are green and you have at least one approval, merge the pull request.
- Post-merge, the release GitHub Actions will trigger and create an "update versions" pull request to the `release` branch.
- Wait for the CI to turn green on the "update versions" pull request.
- Once CI is green, merge the "update versions" pull request.
- After this merge, the actions will trigger again. This time, they'll generate a new tag, create a new release, and publish packages to both GitHub and npm registries.
### 3. Post-Release Activities
After a successful release, ensure you create a backmerge pull request from release to `master`. This ensures that the `master` branch stays up-to-date with the latest versions and changes.
## Host
- run `yarn build`
- serve `out` directory as public