Skip to content

Commit c3f6180

Browse files
authored
Merge pull request #112 from scala/setup
Simplify installation steps and introduce a docker-compose.yml file
2 parents 332f746 + ecf58f1 commit c3f6180

File tree

3 files changed

+29
-6
lines changed

3 files changed

+29
-6
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,25 @@ The site is built and hosted using GitHub Pages and Jekyll.
88

99
## Building locally
1010

11+
### Using Docker Compose
12+
13+
You need to have npm and Docker Compose installed on your machine.
14+
15+
npm install
16+
npm run bower-install
17+
docker-compose up
18+
19+
The generated site is available at `http://localhost:4000`.
20+
21+
### Without Docker Compose
22+
23+
You need to have Ruby and npm installed on your machine.
24+
1125
You can build and view the site locally with:
1226

1327
bundle install
14-
npm install -g bower
15-
bower install
28+
npm install
29+
npm run bower-install
1630
bundle exec jekyll serve
1731

1832
The generated site is available at `http://localhost:4000`.
19-
20-

docker-compose.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
version: '2'
2+
3+
services:
4+
jekyll:
5+
image: bretfisher/jekyll-serve
6+
volumes:
7+
- .:/site
8+
ports:
9+
- '4000:4000'

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@
44
"description": "A starter project including full setup for Jekyll, GulpJS, SASS & BrowserSync",
55
"main": "gulpfile.js",
66
"scripts": {
7-
"test": "echo \"Error: no test specified\" && exit 1"
7+
"test": "echo \"Error: no test specified\" && exit 1",
8+
"bower-install": "bower install"
89
},
910
"author": "Shane Osbourne",
1011
"license": "ISC",
1112
"devDependencies": {
1213
"gulp": "^3.8.8",
1314
"gulp-sass": "^2.1.0",
1415
"browser-sync": "^1.3.7",
15-
"gulp-autoprefixer": "1.0.0"
16+
"gulp-autoprefixer": "1.0.0",
17+
"bower": "1.8.8"
1618
},
1719
"repository": {
1820
"type": "git",

0 commit comments

Comments
 (0)