Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 2.46 KB

README.md

File metadata and controls

80 lines (49 loc) · 2.46 KB
Raw

Beyond Canvas

Gem Version License

Installation

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

    gem "beyond_canvas"

  2. Then execute:

    $ bundle install

  3. Restart your server and rename application.css to application.scss or application.sass (in case you prefer to use the sass syntax):

    $ mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss

  4. Delete all Sprockets directives in application.scss (require, require_tree and require_self) and use Sass’s native @import instead (Here's why?).

  5. Import Beyond Canvas at the beginning of application.scss. Any other styles must be imported after Beyond Canvas to avoid issues:

    @import 'beyond_canvas'

  6. Add the following to application.js:

    //= require beyond_canvas

  7. Mount the engine in your routes file:

    mount BeyondCanvas::Engine => "/<your-mounting-path>"

  8. Run the generator:

    $ rails g beyond_canvas:install

    This will generate config/initializers/beyond_canvas.rb file, used for general Beyond Canvas configuration. For more details see the Configuration section.

Configuration

TBD

Documentation

TBD

Contributing

Please see CONTRIBUTING.

Changelog

Beyond Canvas's changelog is available here.

License

beyond_canvas is Copyright © 2019 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!