Working with the Source Code

To start working with the Sitecore.Glimpse source code you will need a local copy of the project.

Building the Package

Follow these simple steps:

• Clone this repository to your local file system

  git clone https://github.com/kevinobee/Sitecore.Glimpse.git

• You will need to specify the location of your Sitecore assemblies. Edit the build\environment.props file and set the LibsSrcPath to where your Sitecore assemblies are located.

• From a command prompt type .\build and press Enter. A successful build will have compiled the code, run the unit tests for the project and created the Sitecore.Glimpse NuGet packages in the artifacts\Packages directory.

Installing the Package

Ensure that the website project is set to run with .NET Framework 4.5

Run the following powershell command in the package manager console of the Visual Studio solution for the target website:

install-package Sitecore.Glimpse.Mvc5 -Source <path>

Where <path> is the path to the artifacts\Packages\ folder that was produced by the build command.

Installing the package will do the following:

• Add a module into the ASP.NET pipeline
• Add a handler endpoint that by default be addressable via /Glimpse.axd
• A configuration section at the end of your web.config where the behaviour of the extension can be customised

Testing Sitecore.Glimpse

Open your website in a browser and navigate to http://<yoursite>/Glimpse.axd and click Turn Glimpse On. When you go to http://<yoursite>/ the Glimpse panel should appear in the lower right corner of the browser window.