Step by step guide to setup a new Sitecore Helix solution without Gulp

By

Habitat and Helix

Habitat is an example on how you can set up a Sitecore Helix solution. I have seen several projects using it as a starter.
Habitat is not intended to be a starter solution, or as a recommendation of tools for your solutions. https://github.com/Sitecore/Habitat
I created some notes and steps in notepad while setting up my first and second Helix project. I shared these notes with my team members and it has been used as a way to start new Helix solutions for our team.

Setup new Sitecore Helix Solution

1, Install site 
For Sitecore 8 use SIM.
For Sitecore 9 install site with install.ps1.

2. Create a new project in Visual Studio Online


3. Clone the project



4. Create empty solution


5. Add your Sitecore .gitignore
This is my starter .gitignore.

6. Add nuget.config

7. Add  "empty" node-templates for feature, foundation and project
These will be extended as the solution grows.
My starter node templates on GitHub.
Feature node template with Glass Mapper.

8. Add add-helix-module.configuation
This configuration has a few more configurations than the original created by Marc Duiker.
moduleFoundationTemplatePath, moduleFeatureTemplatePath and moduleProjectTemplatePath is used to have a unique node template for each of the add helix commands.
I explained this in a previous blog post.
sitecoreVersion was added to easier get the correct nuget packages for the current Sitecore version.

The current version of my add-helix-module.configuation sitecoreVersion changes to packages.config sitecoreVersion changes to node .proj file
9. Add build-and-deploy-configuration
This configuration is used in the Build and deploy PowerShell script created by my team member.
With this we can build and deploy Helix solutions without Gulp.
We can now run these commands in the console:
  • build-and-deploy
  • build-and-deploy unicorn
  • unicorn
Look at his post for details and his GitHub for the latest version of the PowerShell script and configuration.

10. Add publishingsettings.targets
This is a helper for the local publish profile. The local publish profile is created for each of the projects based on the module templates.

Your structure should look something like this now

GitHub

My GitHub with the starter files

Additional notes

I recommend to start every new Sitecore Helix solution from scratch
I will later create blog posts on how to add Unicorn(serialization), and GlassMapper to this "empty" solution

Comments

Post a Comment

Popular posts from this blog

Step by step guide to add Glass Mapper to Helix solution

By
Image
How to add Glass Mapper to Sitecore Helix solution There are probably different ways to set this up in a Helix solution. I have done this setup in 4 of our projects, and it has become the "template" for our new Helix solutions. We create one foundation project, which has all the glass nuget packages installed, we also choose to add a glass base in the foundation layer. All new features will have access to this glass base interface through a project reference.  I have had a lot of discussions with my co workers on where to add common fields that would be used in several feature projects. If it should be in the Glass Mapper foundation project or in a new foundation project. On "small" projects we choose to add it in the Glass Mapper foundation project, on larger projects we created a separate foundation project to add these fields and their interfaces with Glass Mapper mapping. 1. Create the Visual studio project From the Package Manager Console run
Read more

Using interfaces with Glass Mapper

By
Image
In one of my previous blog post I wrote an example on how to add Glass Mapper to Helix . I will in this blog post provide some code examples on how to map different fields with Glass Mapper. I will also provide some examples on how you could benefit more from Glass Mapper by using interfaces instead of models. Why use interfaces instead of models Interfaces can be inherited multiple times, this works well with inherited templates in Sitecore. We create the common fields in the Helix Foundation layer, and use the mappings in multiple feature projects. The mapping is created in separate interfaces. The model(interface) that should use the fields only needs to inherit from these interfaces. For example a simple component with Title and Rich Text would only need to inherit from the GlassBase, Title and Rich Text interface IMyComponent   :   IGlassBase ,   ITitle ,   IRichText Inside Sitecore the MyComponent would need the Title and RichText field The view then has access
Read more

Enable PowerPaste to Sitecore Rich Text Editor

By
In this blog post I will show how you can change Rich Text to behave similar like the TinyMCE PowerPaste plugin . Changing the behaviour of paste  When an editor is pasting text in the rich text editor, we can control how much formatting is removed. In this example I have set the Paste to remove everything except newlines. This setup could help content editors to easier move text from work documents(or other 3rd party tools) over to Sitecore without needing to use one of the paste buttons. Changes needed to apply "Power Paste" In the file: ~/sitecore/shell/Controls/Rich Text Editor/EditorPage.aspx there is an EditorUpdatePanel with the setting StripFormattingOptions and StripFormattingOnPaste . The original values are set to "MSWordRemoveAll,ConvertWordLists". If we change this to StripFormattingOptions="AllExceptNewLines" StripFormattingOnPaste="AllExceptNewLines" we would have the "Power Paste" activated. Other opti
Read more