Sitecore Sidekick

desktop-icon

sidekickmain

shift+alt+s will open the sidekick.

Live presentation at the Portland OR Sitecore User Group can be found here.  Video on YouTube

Where do i get it?

  1. Marketplace package (Pending sitecore approval)
  2. Nuget Package
  3. Source on Github

How do i install it?

Great care was taken to insure that installation was as easy as possible, so there are no manual steps to get Sidekick installed (other than actually installing it in any of the three methods above).  There are however configuration options for individual applications within Sidekick that should be customized.  See documentation for individual apps for more details (coming soon…)

Sidekick requires Sitecore 7.1 or higher.

What can i build with it?

learn to build your own Sidekick app here

What is it?

Sidekick is a platform in which to serve angularjs apps with a micro-service back-end from within Sitecore. This makes it a flexible and extensible platform to provide highly reactive and responsive single page applications for Sitecore. Some features include:

  1. Resources are delivered from an embedded location in the dll.  This makes it so that the installation footprint is extremely small since it ends up simply being a dll and a config file.
  2. Applications may be hidden or shown to specific roles, users, or admin only.
  3. Each application’s stylesheets and javascript are dynamically compiled into a single document to reduce http requests.
  4. The sidekick is available in three contexts, Content Editor, Experience Editor, and Desktop.
  5. Each application is driven from an individual binary as well as an individual configuration file, so individual apps can easilly be removed if they are not desired by removeing the binary and config for the app that’s not desired.

Applications

  1. Editing context
  2. Content Migrator
  3. Audit Log

How does it work?

When Sidekick starts up for the first time it’ll check to see if the desktop icon exists, if it doesn’t it’ll create one with the icon appropriate to the version of Sitecore.  It then wires up some MVC routing to direct traffic that starts with /scs to sidekick which it then uses a custom http handler to deliver content out of an embedded dll.  After this it runs a custom pipeline to populate all the applications contained within Sidekick.  Each time an application is loaded it aggregates all javascript and stylesheets into a cached single js and css file to minimize requests.  Finally a bit of javascript is injected into Sitecore to allow for registration of the key command shift+alt+s to open it in each context.