Skip to content

Simplify installation steps and introduce a docker-compose.yml file #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.


9 changes: 9 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version: '2'

services:
jekyll:
image: bretfisher/jekyll-serve
volumes:
- .:/site
ports:
- '4000:4000'
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@
"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",
"devDependencies": {
"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",
Expand Down