{"id":20574746,"url":"https://github.com/macpaw/macpaw-ui","last_synced_at":"2025-04-06T06:13:51.902Z","repository":{"id":37931668,"uuid":"272719932","full_name":"MacPaw/macpaw-ui","owner":"MacPaw","description":"UI Kit for MacPaw Web Projects","archived":false,"fork":false,"pushed_at":"2025-03-25T16:41:42.000Z","size":2728,"stargazers_count":35,"open_issues_count":5,"forks_count":5,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-30T04:09:30.082Z","etag":null,"topics":["frontend","react","ui-kit"],"latest_commit_sha":null,"homepage":"https://ui.macpaw.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MacPaw.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-16T13:47:04.000Z","updated_at":"2025-03-25T16:41:46.000Z","dependencies_parsed_at":"2023-10-04T18:05:21.233Z","dependency_job_id":"4bd84b03-2578-45a4-9ee5-3c2ebef03690","html_url":"https://github.com/MacPaw/macpaw-ui","commit_stats":null,"previous_names":[],"tags_count":216,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacPaw%2Fmacpaw-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacPaw%2Fmacpaw-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacPaw%2Fmacpaw-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacPaw%2Fmacpaw-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MacPaw","download_url":"https://codeload.github.com/MacPaw/macpaw-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247441059,"owners_count":20939239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["frontend","react","ui-kit"],"created_at":"2024-11-16T05:36:55.382Z","updated_at":"2025-04-06T06:13:51.884Z","avatar_url":"https://github.com/MacPaw.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# macpaw-ui\n\n## Installation\n\nInstall with npm:\n\n```bash\nnpm install --save @macpaw/macpaw-ui\n```\n\nor with yarn:\n\n```bash\nyarn add @macpaw/macpaw-ui\n```\n\nAnd import stylesheets manually:\n\n```jsx\nimport '@macpaw/macpaw-ui/lib/ui.css';\n```\n\n## Adding new Component\n\n- Add Component's JSX and styles to [src/%ComponentName%](/src) directory\n- Import Component's JS, styles to [ui.js](/src/ui.js) and [ui.scss](/src/ui.scss) correspondingly\n- Add document page in `/pages/%component-name%.mdx`\n\n## Adding new Icons\n\n- 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)\n- Add new SVG file icon to `src/Icons/svg/%name%_icon.svg`\n- Run `yarn icons` CLI command\n\n## Requirements\n\n- Node 20+\n- npm 7+ (lock file v2)\n\n## Library Release Process\n\nOur 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.\nWe use [changesets](https://github.com/changesets/changesets) for version and release management.\n\n### 1. Adding Changes\n\nWhenever you introduce a new change, run the command:\n\n\u003e You have to do this at least once per branch with some changes.\n\n```bash\nnpm run changes:add\n```\n\n- 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).\n- After completing the CLI prompts, commit the changes with a commit message similar to `chore: update changesets`.\n\n### 2. Releasing and Publishing\n\nSteps to make a release:\n- To initiate a release, create a pull request from `master`` to release with the title Release.\n- Ensure all CI checks pass successfully.\n- Once CI checks are green and you have at least one approval, merge the pull request.\n- Post-merge, the release GitHub Actions will trigger and create an \"update versions\" pull request to the `release` branch.\n- Wait for the CI to turn green on the \"update versions\" pull request.\n- Once CI is green, merge the \"update versions\" pull request.\n- 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.\n\n### 3.  Post-Release Activities\n\nAfter 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.\n\n## Host\n\n- run `yarn build`\n- serve `out` directory as public\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmacpaw%2Fmacpaw-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmacpaw%2Fmacpaw-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmacpaw%2Fmacpaw-ui/lists"}