{"_id":"58734dc7dd69441900171473","__v":0,"user":"55a6caa022cfa321008e01d6","category":{"_id":"5605f2bba4574a0d00811365","__v":26,"pages":["5608e4d6c5cff70d007d00d5","5608e4e7c5cff70d007d00d8","5608e4fbc5cff70d007d00da","5608e5096d8c440d000c79f3","5608e5156d8c440d000c79f6","5608e52331beb60d001b6558","5608e8248aedf50d0004cf98","5608e87e8aedf50d0004cf9b","5609bf4f9f85a70d00908530","562822dd5cfea90d00ddc5d7","562831c40653060d00a2f750","563d2732260dde0d00c5eab1","5660d2bee163310d006b19c1","567bb35b93919f0d00c97b1c","567bba643241c20d00b730de","567bbc14b56bac0d0019d933","567bc0473241c20d00b730e5","568b6bd8fe6fcc0d006dc8f7","56a427125fb2530d00421b67","56a42a5194ec0a0d00b3a012","56a42aaa545bc50d000e3ada","56ddff97bea78e20003a778f","56de00ab26744429006648ba","56de12a33168720e00c11b02","56e37f388b32a10e00f79755","56e73362e622c90e00dc55b3"],"project":"55a6e72e8cc73e0d00096635","version":"55a6e72f8cc73e0d00096638","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-26T01:19:55.795Z","from_sync":false,"order":2,"slug":"installation-and-launch","title":"Installation and Launch"},"parentDoc":null,"project":"55a6e72e8cc73e0d00096635","version":{"_id":"55a6e72f8cc73e0d00096638","project":"55a6e72e8cc73e0d00096635","hasReference":false,"__v":29,"hasDoc":true,"createdAt":"2015-07-15T23:05:19.125Z","releaseDate":"2015-07-15T23:05:19.125Z","categories":["55a6e7308cc73e0d00096639","55b7ed07aea7c8190058badb","5604567c0c78b00d0039b191","5605e6f23a93940d002b3e4a","5605f2bba4574a0d00811365","5605f309a4574a0d00811366","5608e3b98aedf50d0004cf8f","5608e4318aedf50d0004cf90","5608e6b5a7cc2f0d00d9754d","5608e6d331beb60d001b6560","5608f879a7cc2f0d00d97580","560b097887b71d0d000d3bd9","560b13cbafa0990d00979545","560b5cbec341310d00de2a01","560b5cd0c341310d00de2a02","566a35b81e08750d00a0c49b","566a3e8503b4b20d00d02a4a","567889d307bf6a0d0083edc8","569c8b7c15bb390d00db6f9d","56b254dc65ddf50d0076ba8f","57a8ebc4cdeea20e001d2a63","57e48a4000c8680e00fae6e7","5808216773557d0f00a1e428","58105ad54a8aa50f00aa4cba","58105bf298aea40f00afa3ba","58105f548a4aed0f00d67536","581061b898aea40f00afa3be","584b3de7e5f3a42300df6ef7","596839a75965d400155bb750"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-09T08:45:59.417Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"<span id=\"Prerequisites\">To smoothly set up Stencil on Windows, please first verify the requirements listed here: </span>\n\n* [Root Permissions](#root_win)\n* [Git Client and Git BASH](#git_win)\n* [Python Installation](#python_win)\n* [Python/Node Configuration](#python_win)\n* [Node.js Installation](#Node+npm_Win)\n* [Visual Studio Installation](#vs_win)\n* [Visual Studio Version/Node Configuration](#vs_win_npm)\n* [Next Steps](#next)\n\nThe following instructions have been tested on Windows 8. Dependencies for other platforms will be added upon further testing.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"* Microsoft Visual Studio (2013 or later) is among the Windows dependencies listed below. If you do not already have it installed, Visual Studio [installation](#vs_win) can occupy your machine for several hours. Please&#160;schedule that step for a time when it will not interrupt your work.\",\n  \"title\": \"Schedule Adequate Time\"\n}\n[/block]\n## <span id=\"root_win\"> 1. Root Permissions </span>\n\nYou must have authorization to run Powershell \"as administrator\" on your machine.\n\n## <span id=\"git_win\"> 2. Git Client and Git BASH</span>\n\nYou must have a Git client installed. The <a href=\"https://git-for-windows.github.io/\" target=\"_blank\">Git for Windows</a> distribution includes a Git client, and also provides the Git BASH emulator for command-line access.\n\n## <span id=\"python_win\"> 3. Python Installation </span>\n\nInstall <a href=\"https://www.python.org/downloads/windows/\">Python 2.7.x for Windows</a>. (This is required for Visual Studio's Windows Build Tools, installed below. \nPython 3.x is not supported.) \n\nIn the installer dialog shown below, change the bottom default, so as to enable the `Add python.exe to Path` option. This provides global command-line access to Python.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fa2a7e8-prereqs-python-2.png\",\n        \"prereqs-python-2.png\",\n        499,\n        435,\n        \"#f0f0ec\"\n      ],\n      \"caption\": \"Change the bottom default to enable \\\"Add python.exe to Path.\\\"\",\n      \"sizing\": \"smart\"\n    }\n  ]\n}\n[/block]\n## <span id=\"Node+npm_Win\"> 4. Node.js Installation </span>\n\nStencil requires the <a href=\"https://nodejs.org/\">Node.js</a> runtime environment, version <a href=\"https://nodejs.org/en/blog/release/\">4.x through 7.x</a>.\n\nOn Windows, we have tested Stencil CLI on selected Node.js versions from <a href=\"https://nodejs.org/en/blog/release/v4.6.1/\">4.6.1</a> through <a href=\"https://nodejs.org/en/blog/release/v7.10.0/\">7.10.0</a>. We recommend that you install only an LTS (\"Long-Term Support\"/\"Mature and Dependable\") version, and that you download that version's `.msi` installer (not its `.exe` binary).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fdd4eaa-prereqs-node-jswin-setup.png\",\n        \"prereqs-node-js~win-setup.png\",\n        509,\n        398,\n        \"#f0f0ef\"\n      ],\n      \"caption\": \"Node.js and npm installer.\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Node.js on Windows\",\n  \"body\": \"* You can choose to instead download the latest x.x version of Node.js from the Node.js Foundation's archives, using URLs of the form: https://nodejs.org/dist/latest-v4.x/, https://nodejs.org/dist/latest-v7.x/, etc. In&#160;all cases, we recommend installing only LTS (\\\"Long-Term Support\\\"/\\\"Mature and Dependable\\\") versions. However, please see the restriction on technical assistance in the [Notes on Dependencies](#versclaimer) below.\\n\\n* You will need to restart your computer to complete Node.js installation.\\n\\n* To verify your Node.js installation or reinstallation, [this blog post](http://blog.teamtreehouse.com/install-node-js-npm-windows) provides Windows-specific tips and tests.\"\n}\n[/block]\n### <span id=\"python_win_npm\"> 5. Python/Node Configuration </span>\n\nAfter installing both Python and Node.js, configure Python within the Node.js runtime environment by running this npm command:\n\n```\nnpm config set python python2.7\n```\n\n<span id=\"Node+npm\"> </span> \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"About npm (Node Package Manager)\",\n  \"body\": \"The [npm](https://www.npmjs.com/) package manager was installed as part of Node.js. As you proceed through Stencil CLI setup (and later refreshes), you will use this command-line utility to install packages/modules, and to configure and manage dependencies and their versions.\"\n}\n[/block]\n## <span id=\"vs_win\"> 6. Visual Studio Installation </span>\n\nInstall MicroSoft [Visual Studio](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx). Stencil requires a 2013 or later release, Community Edition (free) or higher. \n\nBe sure to install Visual Studio's \"Common Tools\" component. You can also add this component later in the window shown below.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Hurry Up and Wait\",\n  \"body\": \"Visual Studio installation is a lengthy process, and can take several hours. However, Visual Studio's Windows Build Tools will be required later to create the `stencil-cli` binary command during [Stencil CLI installation](/docs/installing-stencil-cli-1).\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7a5fed6-prereqs-visual-studio.png\",\n        \"prereqs-visual-studio.png\",\n        1354,\n        642,\n        \"#eae7df\"\n      ],\n      \"caption\": \"Install Visual Studio's \\\"Common Tools.\\\"\",\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\n## <span id=\"vs_win_npm\"> 7. Visual Studio Version/Node Configuration </span>\n\nFinally, configure Visual Studio within the Node.js runtime environment by running the following npm command. \n(Replace the `2015` parameter with `2013` or `2017`, as needed, to match the Visual Studio release you have installed:)\n\n```\nnpm config set msvs_version 2015\n```\n\n<span id=\"versclaimer\"> </span>\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Notes on Dependencies\",\n  \"body\": \"* While alternate versions might also support Stencil, BigCommerce does not offer technical assistance on substitutions for, or customized versions of, the tested dependencies listed here.\\n\\n* Once Stencil is fully installed, you can check dependencies' installed versions by examining your \\n<span class=\\\"inline-code\\\">&lt;theme-name&gt;/package.json</span>file.\\n\\n* If you run into any problems with Stencil installation or launch, please first see our [Troubleshooting Your Setup](/docs/troubleshooting) page. Next, please consult our [Support](https://developer.bigcommerce.com/support/) resources, which include community/peer support via BigCommerce and Stack Overflow forums.\"\n}\n[/block]\n## <span id=\"next\" > 8. Next Steps </span>\n\nIn the next step, you will <a href=\"/docs/installing-stencil-cli-1\">install</a> the Stencil framework.","excerpt":"","slug":"prerequisites-windows","type":"basic","title":"Windows Prerequisites"}

Windows Prerequisites


<span id="Prerequisites">To smoothly set up Stencil on Windows, please first verify the requirements listed here: </span> * [Root Permissions](#root_win) * [Git Client and Git BASH](#git_win) * [Python Installation](#python_win) * [Python/Node Configuration](#python_win) * [Node.js Installation](#Node+npm_Win) * [Visual Studio Installation](#vs_win) * [Visual Studio Version/Node Configuration](#vs_win_npm) * [Next Steps](#next) The following instructions have been tested on Windows 8. Dependencies for other platforms will be added upon further testing. [block:callout] { "type": "warning", "body": "* Microsoft Visual Studio (2013 or later) is among the Windows dependencies listed below. If you do not already have it installed, Visual Studio [installation](#vs_win) can occupy your machine for several hours. Please&#160;schedule that step for a time when it will not interrupt your work.", "title": "Schedule Adequate Time" } [/block] ## <span id="root_win"> 1. Root Permissions </span> You must have authorization to run Powershell "as administrator" on your machine. ## <span id="git_win"> 2. Git Client and Git BASH</span> You must have a Git client installed. The <a href="https://git-for-windows.github.io/" target="_blank">Git for Windows</a> distribution includes a Git client, and also provides the Git BASH emulator for command-line access. ## <span id="python_win"> 3. Python Installation </span> Install <a href="https://www.python.org/downloads/windows/">Python 2.7.x for Windows</a>. (This is required for Visual Studio's Windows Build Tools, installed below. Python 3.x is not supported.) In the installer dialog shown below, change the bottom default, so as to enable the `Add python.exe to Path` option. This provides global command-line access to Python. [block:image] { "images": [ { "image": [ "https://files.readme.io/fa2a7e8-prereqs-python-2.png", "prereqs-python-2.png", 499, 435, "#f0f0ec" ], "caption": "Change the bottom default to enable \"Add python.exe to Path.\"", "sizing": "smart" } ] } [/block] ## <span id="Node+npm_Win"> 4. Node.js Installation </span> Stencil requires the <a href="https://nodejs.org/">Node.js</a> runtime environment, version <a href="https://nodejs.org/en/blog/release/">4.x through 7.x</a>. On Windows, we have tested Stencil CLI on selected Node.js versions from <a href="https://nodejs.org/en/blog/release/v4.6.1/">4.6.1</a> through <a href="https://nodejs.org/en/blog/release/v7.10.0/">7.10.0</a>. We recommend that you install only an LTS ("Long-Term Support"/"Mature and Dependable") version, and that you download that version's `.msi` installer (not its `.exe` binary). [block:image] { "images": [ { "image": [ "https://files.readme.io/fdd4eaa-prereqs-node-jswin-setup.png", "prereqs-node-js~win-setup.png", 509, 398, "#f0f0ef" ], "caption": "Node.js and npm installer." } ] } [/block] [block:callout] { "type": "info", "title": "Node.js on Windows", "body": "* You can choose to instead download the latest x.x version of Node.js from the Node.js Foundation's archives, using URLs of the form: https://nodejs.org/dist/latest-v4.x/, https://nodejs.org/dist/latest-v7.x/, etc. In&#160;all cases, we recommend installing only LTS (\"Long-Term Support\"/\"Mature and Dependable\") versions. However, please see the restriction on technical assistance in the [Notes on Dependencies](#versclaimer) below.\n\n* You will need to restart your computer to complete Node.js installation.\n\n* To verify your Node.js installation or reinstallation, [this blog post](http://blog.teamtreehouse.com/install-node-js-npm-windows) provides Windows-specific tips and tests." } [/block] ### <span id="python_win_npm"> 5. Python/Node Configuration </span> After installing both Python and Node.js, configure Python within the Node.js runtime environment by running this npm command: ``` npm config set python python2.7 ``` <span id="Node+npm"> </span> [block:callout] { "type": "info", "title": "About npm (Node Package Manager)", "body": "The [npm](https://www.npmjs.com/) package manager was installed as part of Node.js. As you proceed through Stencil CLI setup (and later refreshes), you will use this command-line utility to install packages/modules, and to configure and manage dependencies and their versions." } [/block] ## <span id="vs_win"> 6. Visual Studio Installation </span> Install MicroSoft [Visual Studio](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx). Stencil requires a 2013 or later release, Community Edition (free) or higher. Be sure to install Visual Studio's "Common Tools" component. You can also add this component later in the window shown below. [block:callout] { "type": "warning", "title": "Hurry Up and Wait", "body": "Visual Studio installation is a lengthy process, and can take several hours. However, Visual Studio's Windows Build Tools will be required later to create the `stencil-cli` binary command during [Stencil CLI installation](/docs/installing-stencil-cli-1)." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/7a5fed6-prereqs-visual-studio.png", "prereqs-visual-studio.png", 1354, 642, "#eae7df" ], "caption": "Install Visual Studio's \"Common Tools.\"", "sizing": "80" } ] } [/block] ## <span id="vs_win_npm"> 7. Visual Studio Version/Node Configuration </span> Finally, configure Visual Studio within the Node.js runtime environment by running the following npm command. (Replace the `2015` parameter with `2013` or `2017`, as needed, to match the Visual Studio release you have installed:) ``` npm config set msvs_version 2015 ``` <span id="versclaimer"> </span> [block:callout] { "type": "info", "title": "Notes on Dependencies", "body": "* While alternate versions might also support Stencil, BigCommerce does not offer technical assistance on substitutions for, or customized versions of, the tested dependencies listed here.\n\n* Once Stencil is fully installed, you can check dependencies' installed versions by examining your \n<span class=\"inline-code\">&lt;theme-name&gt;/package.json</span>file.\n\n* If you run into any problems with Stencil installation or launch, please first see our [Troubleshooting Your Setup](/docs/troubleshooting) page. Next, please consult our [Support](https://developer.bigcommerce.com/support/) resources, which include community/peer support via BigCommerce and Stack Overflow forums." } [/block] ## <span id="next" > 8. Next Steps </span> In the next step, you will <a href="/docs/installing-stencil-cli-1">install</a> the Stencil framework.