ThirdMirrors
/
cheatsheets
mirror of https://gitee.com/Hawkin99/cheatsheets.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Windows quickstart tutorial on CONTRIBUTING.md 

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
```
This commit is contained in:
Gerasimos (Makis) Maropoulos 2017-12-21 06:33:07 +02:00 committed by GitHub
parent ac5e2d7fde
commit 92c42d59a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -10,6 +10,35 @@ bundle install
env PORT=4001 yarn run dev
```
### 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
```
## CSS classes
See <https://devhints.io/cheatsheet-styles> for a reference on styling.