Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 5.05 KB

README.md

File metadata and controls

83 lines (53 loc) · 5.05 KB
Raw

Kentico Inspector

Join the chat at https://kentico-community.slack.com Build status first-timers-only Github All Releases

Kentico Inspector (formerly KInspector) is an application for analyzing the health, performance and security of Kentico EMS solutions.

Kentico Inspector was initially developed as an internal application by the Kentico consulting team to help evaluation customer's web sites. We quickly realized that the broader community would benefit from this as well, so we made it open source.

The application is Kentico version agnostic and has no dependencies on version-specific DLLs. Most modules are designed to support version 10 and later, but some will work on older versions as well.

Get the application

Introduction to V4

Version 4 is a complete rewrite of the tool. We wanted to create a better, more flexible codebase for both the front and back ends.

Download the latest release.

⚠️ V4 is currently ALPHA and we're still porting reports.

If you need a report that hasn't been migrated yet, please use the latest release of V3 or consider porting it and submitting a PR!

Running the tool

The application supports two modes currently: console and IIS. Console mode is useful if you just want to quickly run the tool occasionally, whereas IIS mode allows you to have it always available, for example, on a development server. In either case you need to extract the entire package in a folder.

📍 Note:

The application needs permission to create/modify files in the directory it is run from to save instances to a file.

Console Mode

To run in console mode simply run KenticoInspector.WebApplication.exe and open your browser to either https://localhost:5001 or http://localhost:5000.

IIS Mode

To run in IIS mode point your IIS directory to the folder you extracted everything to and make sure the application pool's .NET CLR version is set to No managed code. Open the site in your browser.

Contributing

Want to improve the Kentico Inspector? Great! Read the contributing guidelines and then check out the open issues (especially issues marked as "good first issue") to get started.

If anything feels wrong or incomplete, please let us know. Create a new issue or submit a pull request.

Development Requirements

All versions below are from a known working environment. Lower versions may work but are not tested.

First run

Even if you don't plan to make any changes in the Clietn UI application, you'll need to build it before your first run and any time the client code is updated. To build the Client UI application (required anytime the client UI code is updated unless you are using the UI Development debug launch setting):

Frontend build instructions

  1. Open Powershell/Command Prompt
  2. Change the directory to ./KenticoInspector.WebApplication/ClientApp
  3. Run npm i
  4. Run npm run build

Backend build instructions

  1. Open KInspector.sln in Visual Studio
  2. Do a build
  3. Make sure the KenticoInspector.WebApplication project is the start up project
  4. You can run it with either the IIS Express or Console debug launch settings

If you want to work on the Client UI applicaiton, there's a few additional steps to go through.

  1. Open the ./KenticoInspector.WebApplication/ClientApp directory in your editor of choice (Visual Studio Code is recommended) as well as in Powershell
  2. In Powershell, run npm i (if you haven't yet) and npm run serve
  3. Leave the application is running.
  4. Follow the steps to build the backend, but run it using the UI Development debug launch settings.
    • This runs the backend with a proxy to the running instance you started in Powershell and allows you to take advantage of the hot-reloading of the clientn application

Analytics