buddhi-desilva / alchemy_spree

An Alchemy CMS and Spree connector

Home Page:https://github.com/magiclabs/alchemy_spree

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Alchemy CMS Spree Connector

The World's Most Flexible E-Commerce Platform meets The World's Most Flexible Content Management System!

This gem is a Alchemy CMS and Spree connector.

For now it does this:

  1. It provides an Alchemy module that displays Spree admin in an iframe inside Alchemy admin.
  2. It gives you a new Essence for Alchemy called EssenceSpreeProduct that you can use to place a Spree product on your page.
  3. It adds a TinyMCE editor to the Spree product description textarea.
  4. Shares admin session between Alchemy and Spree. You have to use this Spree branch that offers custom user authentication) to make this work.

Installation

Add this line to your application's Gemfile:

gem 'alchemy_spree'

And then execute:

$ bundle

Or install it yourself as:

$ gem install alchemy_spree

Install the migrations:

$ rake alchemy_spree:install:migrations

Migrate the database:

$ rake db:migrate

Mount the engine into your routes:

# config/routes.rb
mount AlchemySpree::Engine => '/'

Usage

Create a new Element for Alchemy

# config/alchemy/elements.yml
- name: product
  contents:
  - name: spree_product
    type: EssenceSpreeProduct

Generate the views

$ rails g alchemy:elements --skip

Place this element on a page layout

# config/alchemy/page_layouts.yml
- name: products
  elements: [product]

You can haz Spree product!

# app/views/alchemy/elements/_product_view.html.erb
<%= element.ingredient('spree_product') %>

Alchemy <3 Spree!

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

An Alchemy CMS and Spree connector

https://github.com/magiclabs/alchemy_spree

License:MIT License


Languages

Language:Ruby 97.4%Language:JavaScript 2.6%