nbsamar/engine

Static ecommerce business logic written with Reflux.js

Jekyll-Store/Engine

Even though Jekyll-Store Engine was written with Jekyll and the Jekyll-Store solution in mind, it is decoupled from most implementation specifics and could just as easily serve the basis of any static-site ecommerce solution. It also has been written such that most of the code is reachable from the main JekyllStoreEngine object to enable extensibility.

Actions

As with all Flux architectures, interaction in Jekyll-Store Engine flows uni-directionally from Actions to Stores and from Stores to any components listening to them. The following is a list of the actions:

• setItem - Sets the quantity of an item in the basket.
• removeItem - Removes an item from the basket.
• setAddress - Sets the address, specifically the country.
• setDelivery - Sets the delivery method to be used to deliver the order.
• loadProducts - Loads products.
• loadCountries - Loads countries.
• loadDeliveryMethods - Loads delivery methods.
• setPaymentOptions - Sets the payment options and purchase hook.
• purchase - Processes order.
• completed - Called when payment has been successully processed.
• refreshCheckout - (Used internally).
• setErrors - Can be used to set errors manually.

For more information, consult the Actions reference page.

Stores

Stores are to be considered the absolute source of truth for the data they trigger. For the most part, data is immutable, using seamless-immutable arrays and objects. As such, the triggered data cannot be changed by other listeners. The following is a list of the stores and what they publish:

• AddressStore - The current address, specifically the country.
• BasketStore - The items currently in the basket.
• CountriesStore - The list of all countries.
• DeliveryMethodsStore - The available delivery methods for the current address.
• DeliveryStore - The currently selected delivery method and it's associated cost.
• OrderStore - The current state of the order with totals, adjustments and errors.
• PaymentOptionsStore - The payment options.
• ProductsStore - The list of all products.
• CheckoutStore - (Used internally).

For more information, consult the Stores reference page.

Calculators

Calculators are simple functions that take an order and return a number, usually representing the cost for an adjustment, such as the delivery rate. The following is a list of the calculators:

• FixedCalculator - Returns a fixed amount, regardless of the order.
• PercentCalculator - Returns a percentage of one of the order's totals.
• TieredCalculator - Returns an amount dependent on which tier one of the order's totals falls into.

For more information, consult the Calculators reference page.

Plugins

The following plugins are made to be used with Jekyll-Store Engine:

• Display
• Favourites
• Google-Analytics
• Visited

Contributing

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