Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 1.67 KB

README.md

File metadata and controls

78 lines (48 loc) · 1.67 KB
Raw

Polaris ViewComponents

Polaris ViewComponents is an implementation of the Polaris Design System using ViewComponent.

Polaris ViewComponents

Preview

https://polarisviewcomponents.org

Usage

Render Polaris ViewComponents:

<%= polaris_card(title: "Title") do %>
  <p>Card example</p>
<% end %>

Dependencies

Installation

Add polaris_view_components to your Gemfile:

bundle add polaris_view_components

Run installer:

bin/rails polaris_view_components:install

Upgrade

Check out UPGRADING.md for upgrade instructions.

Development

To get started:

  1. Run: bundle install
  2. Run: yarn install
  3. 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:

rake

Releases

The library follows semantic versioning. To draft a new release you need to run bin/release with a new version number:

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:

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.