Skip to content

Commit e4cc5c5

Browse files
authored
feat: Add Windows Setup Instructions (#151)
Signed-off-by: aceppaluni <aceppaluni@gmail.com>
1 parent 4294480 commit e4cc5c5

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ See [docs/hugo-setup.md](docs/hugo-setup.md) for installing prerequisites (Hugo,
1515
npm i
1616
```
1717

18+
For Windows Setup Instructions [Windows_Setup.md](docs/setup/windows_setup.md)
19+
1820
## Environments
1921

2022
### Dev

docs/setup/windows_setup.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Windows Setup
2+
3+
## Instructions
4+
5+
### Install packages
6+
7+
Run these commands:
8+
9+
```npm i ```
10+
```npm install --save-dev cross-env npm install```
11+
```npm install --save-dev rimraf ```
12+
13+
### Update Package.Json
14+
15+
Navigate to your package.json file
16+
17+
Remove the current script section and replace it with the code below:
18+
19+
```
20+
"scripts": {
21+
"clean": "rimraf public",
22+
"start": "cross-env TAILWIND_MODE=watch NODE_ENV=development npm-run-all clean prelim:twcss --parallel dev:*",
23+
"build": "NODE_ENV=production npm-run-all clean prelim:twcss prod:*",
24+
"prelim:twcss": "npx tailwindcss -i ./assets/css/main.css -o ./static/css/main.css --jit",
25+
"dev:twcssw": "npx tailwindcss -i ./assets/css/main.css -o ./static/css/main.css --jit -w",
26+
"dev:hugo": "hugo server",
27+
"prod:twcss": "./node_modules/tailwindcss/lib/cli.js -i ./assets/css/main.css -o ./static/css/main.css --jit --minify",
28+
"prod:hugo": "hugo --gc --minify"
29+
},
30+
```
31+
Save the file.
32+
33+
### Run Start Command
34+
35+
Run ```npm run start``` to spin up the local server.
36+
37+
You should see ```Web Server is available at http://localhost:1313/```
38+
39+
Open this link to see the project
40+
41+
You have just setup Hiero-Website locally!!

0 commit comments

Comments
 (0)