Essence
Installation
-
Add this line to your application's Gemfile:
gem 'epages-essence'
-
Execute the following command:
bundle install
-
Add the following lines to the
<head>
and<body>
of the layout you are going to use (e.g.app/views/layouts/application.html.erb
):<!DOCTYPE html> <html> <head> <%= stylesheet_link_tag 'essence/beyond', 'data-turbo-track': 'reload' %> <%= javascript_importmap_tags 'essence/application' %> <%= yield :head %> </head> <body> <%= render template: 'essence/beyond/body' %> </body> </html>
Any
javascript_import_module_tag
must come after thejavascript_importmap_tags
declaration, that's why<%= yield :head %>
is placed after this declaration. Seeimportmap-rails
gem.
Component preview
Essence includes a Rails application that uses Lookbook. By running this app, you can preview the components and explore the possibilities that Essence offers.
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:
-
Change directory to
site
, which is the Lookbook project's folder:cd site
-
Start the web server:
bin/rails server
Contributing
Please see CONTRIBUTING.
License
Essence is Copyright © 2024 ePages GmbH. It is free software, and may be redistributed under the terms specified in the LICENSE file.
About ePages
As the largest independent provider of online shop software in Europe, ePages specialises in high-performance ecommerce solutions for small and medium-sized businesses. Today, 100,000 companies in 70 countries operate professional online shops with ePages software in the cloud.
And we love open source software! Check out our other projects, or become part of our team and develop great ecommerce software with us!