Carbide for Umbraco

Get started

Installation

This project uses the newer project file "PackageResource" configuration for NuGet packages. This means that Carbide's NuGet packages are downloaded to your user folder, and used much like assemblies in the GAC, so they won't interfere with the /packages folder in the root of your project if you're using the standard (default) packages.config method in your solution.

1. NuGet method

Carbide can be installed in several ways, depending on how you want to use it. If you're simply interested in using it as-is to gain the feature benefits, you could simply install the Nuget package. This will provide a simple means to get up and running, and also allow you to stick with specific versions as you plan Umbraco upgrades.

2. Download method

You could also download the project and incorporate the files into your project. In the future you would have to update Carbide manually, but it would provide a way to use Carbide without an additional repository.

3. Cloned repository method

The recommended way to incorporate Carbide is to add the Carbide repository to your project (solution) folder as a git submodule. In this way you have control over the version of Carbide being used, and can pull changes from the master repository.


Configuration

Currently, Carbide is built on .NET CLR 4.5, and references UmbracoCMS.Core 7.10.x. Depending on your use case, you could keep it at this version even with a newer Umbraco CMS version, provided there are no real incompatibilities with Umbraco Core. Ideally, you want to keep the versions in lock-step. So any Carbide solutions should be updated frequently, which is generally a good practice from a security standpoint.

NOTE: Turn on 64-bit IIS Express in Visual Studio, or you won't be able to debug unless all projects in the solution are set to x86. This is due to SharpScss detecting which binary is being used based on compilation flags. It will default to x64 for "Any CPU" configurations even though Visual Studio will always prefer x86. This shouldn't affect deployments to IIS, provided the app pool for the site isn't set to use 32-bit mode.