vc-dev-tools

Tools for automating routine Virto Commerce developing processes.

Features

• Mass clone and update from git repositories
• Mass build for modules
• Module, theme, storefront and common types of repositories supported
• Multi-configuration support. Prepare independent configurations and switch between them easily.
• Multi-branch support
• Mass create symbolic links for Virto Commerce modules
• Fast IIS Application Pool recycle

Prerequisittes

• Node.js
• npm
• Virto Commerce Platform running on local IIS (dedicated Application Pool)

Setup

1. Download / clone the tools repository;
2. Run npm install;
3. Configure environment in .env file:
   • CONFIG - name for currently active configuration
   • LOGIN - username for repository authentication
   • PASSWORD - password for repository authentication
4. Prepare the configuration:
   1. Create a copy of config.json for active configuration (defined in previous step): config.{active configuration}.json
   2. Configuration:
   • directories.repositoriesRoot - local root folder for the repositories
   • directories.platformModulesRoot - Modules folder location for VC Platform
   • build.msbuildPath - full path to msbuild.exe. Note: the path depends on Visual Studio version and edition.
   • build.nugetPath - path to nuget.exe. It's ok to leave the default value.
   • iis.appcmdPath - path to "IIS command line administration tool" (appcmd.exe). It's ok to leave the default value.
   • iis.apppool - name of IIS Application Pool used by VC Platform application
   • branch.all - array of branches to pull while updating the repositories
   • repositories - array of repositories. Single entry structure:

     {
         "name": "default",  // custom name for the repository
         "type": "theme",    // { module | storefront | theme }
         "url": "https://github.com/VirtoCommerce/vc-theme-default" // repository URL
     },
     

Usage

• npm run init - clone all repositories
• npm run update - update all repositories (all branches defined in branch.all)
• npm run build-modules - restore nuget packages and build modules
• npm run mklinks - create directory symbolic links for each module in directories.platformModulesRoot (elevated permissions needed)
• npm run restart-iis - recycle Application Pool defined in iis.apppool (elevated permissions needed).