constellation4sitecore/zodiac-sitecore9-example(opens in a new tab)
Language: JavaScript
- stars
- 0
- watchers
- 4
- forks
- 3
- open issues
- 6
- Last updated
- 12/08/2022
Language: JavaScript
A "complete" Visual Studio 2017 solution that you can fork/clone and use as the basis of your net-new Sitecore implementation project.
Features include:
There are several options, depending upon what you want to do. In all cases, you need a target Sitecore 9.1 installation! so...
If your machine does not meet these minimums, you will likely experience resource-related problems that are virtually impossible to troubleshoot.
Since these instructions are intended for developers expecting to use Zodiac for development, we assume you are installing a "Standalone" local instance of Sitecore on your personal development machine.
It is essential that you have a "stock" copy of Sitecore running before proceeding.
If the answer to anything above is "no", stop now and address these problems.
Continuing will not fix those issues and will make validating Zodiac's install impossible.
Currently there are 3 options:
Go ahead & set up a Working Copy on your local machine. We recommend creating a new Branch based on the "master" branch of whichever repository you choose.
The three repositories mentioned above are linked to each other. In your working copy, you will find up to three *.sln files. Make sure you load the Solution file that matches your Repository name. You can delete the others. For completeness, you should be loading one of the following:
Assuming Visual Studio fires up and everything looks OK, click on the Solution in Solution Explorer and choose "Restore NuGet Packages". After NuGet Packages have been restored, run a Solution Build. Verify that the solution does build. Building will not deploy, and you should not deploy at this stage.
In the "Website" project there is an AppSettings.Config file located at /App_Config/AppSettings.config. You must manually copy this file into your local installation. It contains essential pre-Sitecore config patch settings that must be set to parse the config files correctly.
Example = C:\Inetpub\wwwroot\examplesite\App_Config\AppSettings.config
After Deployment, your install will not start without this file.
In the Solution Explorer select the "Website" project.
If it's not already visible, add the "Web One-Click Publish" toolbar by right-clicking outside any existing Toolbars in Visual Studio, and selecting it from the menu.
In the (now visible) "Publish" toolbar, there should be a "Debug" target selected. Click the cog/gear icon to edit the publishing profile.
Within the "Publish" panel that is now exposed, ensure the "Target Location" matches the location of your IIS Web App's root. (Use the Configure link to change it.)
Example Target Location = "C:\inetpub\wwwroot\examplesite.verndale-local.com"
With the "Website" project selected in Solution Explorer, hit the "publish" button in the One-Click Publish toolbar.
Important! After Visual Studio deploys your solution for the first time, you must run Sitecore immediately. This will install a number of prerequisite Items that allow you to start development.
In Visual Studio, open the _TDS/TdsGlobal.config file for editing.
Modify the following elements to match your local installation:
<SitecoreWebUrl>http://examplesite.verndale-local.com</SitecoreWebUrl>
<SitecoreDeployFolder>C:\inetpub\wwwroot\examplesite.verndale-local.com</SitecoreDeployFolder>
Save and close the config file.
In Visual Studio, select the "Feature.Labels.TDS.Templates" project.
Right-click and choose "Install Sitecore Connector" from the menu.
Use your preferred method to push all TDS projects into your Sitecore installation. Note you may have to push Templates first.
If you are using one of the solutions that includes the Example Site, you need to adjust the configuration files so that Sitecore will resolve the site properly.
Assuming you want the example site to be the "default" site for your install, you need to add the hostname you supplied in the install to your site config.
In the "Website" project in Visual Studio:
Note that if you want the example site, but you don't want it to be the "primary" site on your install, you can always add another hostname to your IIS website bindings. The above instructions still apply.
At this point you should have a running installation using Zodiac (with Constellation) as the backbone. You can now start development of your solution!
For details on how to use various features of this installation, visit https://constellation4sitecore.com/ the official documentation site for Constellation and Zodiac.
A big thank you to Verndale for providing the time to assemble this kit.
(in no particular order)