0.0
The project is in a healthy, maintained state
Essence is an open-source framework that provides ViewComponents, form styles and other functionality for appsdesigned and developed for the online shop software Beyond
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Essence

Gem Version License

Installation

  1. Add this line to your application's Gemfile:

    gem 'epages-essence'
  2. Execute the following command:

    bundle install
  3. 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 the javascript_importmap_tags declaration, that's why <%= yield :head %> is placed after this declaration. See importmap-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:

  1. Change directory to site, which is the Lookbook project's folder:

    cd site
  2. 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!