https://github.com/baoagency/polaris_view_components
ViewComponents for Polaris Design System
https://github.com/baoagency/polaris_view_components
polaris rails ruby shopify
Last synced: about 1 year ago
JSON representation
ViewComponents for Polaris Design System
- Host: GitHub
- URL: https://github.com/baoagency/polaris_view_components
- Owner: baoagency
- License: mit
- Created: 2021-02-19T17:31:34.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-12T17:53:42.000Z (over 1 year ago)
- Last Synced: 2025-04-13T13:57:07.803Z (about 1 year ago)
- Topics: polaris, rails, ruby, shopify
- Language: Ruby
- Homepage: https://polarisviewcomponents.org
- Size: 3.83 MB
- Stars: 414
- Watchers: 13
- Forks: 59
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Polaris ViewComponents
Polaris ViewComponents is an implementation of the Polaris Design System using [ViewComponent](https://github.com/github/view_component).
## Preview
https://polarisviewcomponents.org
## Usage
Render Polaris ViewComponents:
```erb
<%= polaris_card(title: "Title") do %>
Card example
<% end %>
```
## Dependencies
- [Stimulus](https://stimulus.hotwired.dev/)
## Installation
Add `polaris_view_components` to your Gemfile:
```bash
bundle add polaris_view_components
```
Run installer:
```bash
bin/rails polaris_view_components:install
```
## Upgrade
Check out [UPGRADING.md](UPGRADING.md) for upgrade instructions.
## Development
To get started:
1. Run: `bundle install`
1. Run: `yarn install`
1. Run: `bin/dev`
It will open demo app with component previews on `localhost:4000`. You can change components and they will be updated on page reload. Component previews located in `demo/test/components/previews`.
To run tests:
```bash
rake
```
## Releases
The library follows [semantic versioning](https://semver.org/). To draft a new release you need to run `bin/release` with a new version number:
```bash
bin/release VERSION
```
Where the VERSION is the version number you want to release. This script will update the version in the gem and push it to GitHub and Rubygems automatically.
To release a new version of npm package update the package.json file with the new version number and run:
```bash
npm run release
```
After that make sure to commit changes in package.json.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).