GithubHelp home page GithubHelp logo

opportus / storefront-aggregator Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 73 KB

An flexible and extensible content Aggregator for Storefront - Improves user experience and adds dynamic content to your pages.

JavaScript 47.01% CSS 6.64% PHP 46.35%

storefront-aggregator's Introduction

Storefront Aggregator

A flexible and extensible content Aggregator for Storefront... Improves user experience and adds dynamic content to your pages.

Description

The aggregators are registered as custom post type - Edit and manipulate them as such.
You can attach to aggregators the desired type and amount of items and choose on which pages and which template action hook to display each aggregator... It is possible to add multiple aggregators on a single page and/or on a single template hook.
By default, the available item types are 'Last Posts' and 'Last Comments'. Compatible with WooCommerce, you also can aggregate 'Last Products' or 'Last Reviews'.
The aggregate items are slidable and fully responsive. Thanks to FlexSlider.
Features a dedicated Customizer panel in which each aggregator can be deeply customized.

Focus

The main points I've focused on are extensibility and flexibility.

Extensibility

At this stage, any tier developer can add his custom items to aggregate via 3 hooks:

  • aggregator_meta_boxes filter from which we can add custom items types to be selected for aggregation.
  • aggregator_items filter from which we can add the item objects themselves.
  • aggregator_items_template action for hooking a custom item template easily enough inside the aggregator template.

The custom item integration process could optionally get simplified via a little API.

Flexibility

From the setting page, you can display the aggregator via any template action hook of your choice. Of course to adapt its layout to every possible hooks, a Customize section is available for each aggregator.

Coming soon

  • Improved Customizer... More user friendly interface and further styling options such as aggregator layout, margins, etc...
  • HOT, "Edit Items" feature:

| Aggregators Menu |

  |
  -----------------------
  | Aggregator CPT Menu |
  -----------------------
  |         |
  |         | Add New Aggregator
  |         |         |
  |         ------------------------
  |         | Edit Aggregator Page |
  |         ------------------------
  |                   |
  |         __________|______________________________________________________________________
  |        |                                                                                |
  |        |  --------------------                                       ---------------    |
  |        |  | Aggregator Title |                                       | Select Item |    |
  |        |  --------------------                                       ---------------    |
  |        |                                                                                |
  |        |  ----------------------                                                        |
  |        |  | Aggregator Content |                                                        |
  |        |  ----------------------                                                        |
  |        |                                                                                |
  |        |  ---------------------                                                         |
  |        |  | Aggregator Domain |                                                         |
  |        |  ---------------------                                                         |
  |        |            |                                                                   |
  |        |            ---------------                                                     |
  |        |            | Domain Page |                                                     |
  |        |            ---------------                                                     |
  |        |            |                                                                   |
  |        |            ---------------                                                     |
  |        |            | Domain Hook |                                                     |
  |        |            ---------------                                                     |
  |        |            |                                                                   |
  |        |            ------------------------                                            |
  |        |            | Domain Hook Priority |                                            |
  |        |            ------------------------                                            |
  |        |                                                                                |
  |        __________________________________________________________________________________
  |
  -----------------
  | Item CPT Menu |
  -----------------
            |
            | Add New Item
            |         |
            ------------------
            | Edit Item Page |
            ------------------
                      |
            __________|______________________________________________________________________
           |                                                                                |
           | -----------------------------           -----------------------                |
           | |       Item Template       |           |   Select Item Type  |                |
           | |            or             |           -----------------------                |
           | | Drag n Drop Item Elements |           |                     |                |
           | -----------------------------           |                     |                |
           |                                         |                     |                |
           |                                         |  Scans for ALL CPTs |-- Post         |
           |                                         |                     | |              |
           |                                         |                     | -- Post        |
           |                                         |                     | |              |
           |                                         |                     | -- Page        |
           |                                         |                     | |              |
           |                                         |                     | -- Attachment  |
           |                                         |                     | |              |
           |                                         |                     | -- Product     |
           | --------------------  Load on Selection |                     | |              |
           | | Query Args Input |  <-----------------|                     | -- Etc...      |
           | --------------------                    |                     |                |
           |                                         |  Scans for ALL CCTs |-- Comment      |
           |                                         |                     | |              |
           |                                         |                     | -- Comment     |
           |                                         |                     | |              |
           |                                         |                     | -- Pingbacks   |
           |                                         |                     | |              |
           |                                         |                     | -- Trackbacks  |
           |                                         |                     | |              |
           |                                         |                     | -- Etc...      |
           |                                         |                     |                |
           |                                         |                     |-- User         |
           __________________________________________________________________________________

Changelog

v0.2 - 14/09/2016

  • Feature: Possibility to display each aggregator to any page and any template action hook of your choice.
  • Feature: Possibility to Customize each aggregator.

v0.1 - 01/09/2016

  • Beta Release

Licence

MIT License

Copyright (c) 2016 Clément Cazaud

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

storefront-aggregator's People

Contributors

opportus avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.