diff --git a/README.md b/README.md index 4026d43..dc3a0aa 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,25 @@ The site is built and hosted using GitHub Pages and Jekyll. ## Building locally +### Using Docker Compose + +You need to have npm and Docker Compose installed on your machine. + + npm install + npm run bower-install + docker-compose up + +The generated site is available at `http://localhost:4000`. + +### Without Docker Compose + +You need to have Ruby and npm installed on your machine. + You can build and view the site locally with: bundle install - npm install -g bower - bower install + npm install + npm run bower-install bundle exec jekyll serve The generated site is available at `http://localhost:4000`. - - diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..823fd6d --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,9 @@ +version: '2' + +services: + jekyll: + image: bretfisher/jekyll-serve + volumes: + - .:/site + ports: + - '4000:4000' diff --git a/package.json b/package.json index 7003608..e80c23a 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,8 @@ "description": "A starter project including full setup for Jekyll, GulpJS, SASS & BrowserSync", "main": "gulpfile.js", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" + "test": "echo \"Error: no test specified\" && exit 1", + "bower-install": "bower install" }, "author": "Shane Osbourne", "license": "ISC", @@ -12,7 +13,8 @@ "gulp": "^3.8.8", "gulp-sass": "^2.1.0", "browser-sync": "^1.3.7", - "gulp-autoprefixer": "1.0.0" + "gulp-autoprefixer": "1.0.0", + "bower": "1.8.8" }, "repository": { "type": "git",