Windows quickstart tutorial on CONTRIBUTING.md #330
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Developer notes::Starting a local instance ### Windows 1. Install **Ruby**: https://rubyinstaller.org/ * After the installation check the box and type `3` to select the 3rd option * Add `C:\msys64\usr\bin` to PATH env variable * Add `C:\Ruby24-x64\bin` to PATH env variable 2. Install **yarn**: https://yarnpkg.com/en/docs/install#windows 3. Install **jekyll** via command prompt: `gem install jekyll bundler` 4. Install **nodejs && npm**: https://nodejs.org/en/download/ 4. Install **webpack** via command prompt: `npm install -g webpack` 5. If you have any issues after installing ruby, like `HOMEPATH` is not defined, then execute the below commands: ```bash SETX HOMEDRIVE %SYSTEMDRIVE% -m SETX HOMEPATH \Users\%username% -m SET HOME=%SYSTEMDRIVE%\Users\%USERNAME% SETX HOME "%HOME%" ``` #### Start Jekyll and Webpack Go wherever the project's files are located and open a new command prompt, execute the below commands: ```bash yarn install bundle install SET PORT=4001 yarn run dev ```
|
Wow! I don't have a Windows machine to try this on so I'll have to trust your judgement on this :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Developer notes::Starting a local instance
Windows
3to select the 3rd optionC:\msys64\usr\binto PATH env variableC:\Ruby24-x64\binto PATH env variablegem install jekyll bundlernpm install -g webpackHOMEPATHis not defined, then execute the below commands:Start Jekyll and Webpack
Go wherever the project's files are located and open a new command prompt, execute the below commands: