Skip to content

Commit

Permalink
Add index page for demo site
Browse files Browse the repository at this point in the history
  • Loading branch information
kirillplatonov committed Feb 11, 2025
1 parent 7d2a414 commit 598178c
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
36 changes: 36 additions & 0 deletions demo/app/pages/overview.md.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Polaris ViewComponents
---

Polaris ViewComponents is an implementation of the [Polaris Design System](https://polaris.shopify.com/components) using ViewComponents.

## Example

<lookbook-embed
app="http://localhost:4000/lookbook/"
preview="CardComponentPreview"
scenario="default"
panels="source,output">
</lookbook-embed>

## 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
```

## Source code

The source code is available on [GitHub](/~https://github.com/baoagency/polaris_view_components).
1 change: 1 addition & 0 deletions demo/config/application.rb
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,6 @@ class Application < Rails::Application

# Lookbook
config.lookbook.project_name = "Polaris ViewComponents"
config.lookbook.page_paths = ["app/pages"]
end
end

0 comments on commit 598178c

Please sign in to comment.