Skip to content

Commit

Permalink
Add lookbook docs
Browse files Browse the repository at this point in the history
  • Loading branch information
unabris committed Oct 7, 2024
1 parent 2f0b391 commit a148166
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,27 @@
> [!IMPORTANT]
> Any `javascript_import_module_tag` should come after `javascript_importmap_tags` declaration, that's why `<%= yield :head %>` is added after.
## Component preview
Beyond Essence comes with a Rails application that uses [Lookbook](https://lookbook.build/). By running it you can preview the components and see possibilities that Beyond Essence offers.
> [!NOTE]
> Currently, the Lookbook app is in an early stage and is still under development. It does not have a preview of all the components but of most of them.
To run the Lookbook app, follow these steps:
1. Change directory to `site`, the Lookbook project's folder:

```bash
cd site
```

2. Start the web server:

```bash
bin/rails server
```

## Contributing

Please see [CONTRIBUTING](https://github.com/ePages-de/beyond_essence/blob/main/CONTRIBUTING.md).
Expand Down

0 comments on commit a148166

Please sign in to comment.