site-starter

My default Jekyll/S3 website starter template

Want a Jekyll website built?

Download

My standard website starter template. Jekyll build hosted on S3/Cloudfront.

If you don't have Homebrew, Ruby, Bundler, Node.js or Gulp already – follow the starting from scratch instructions first.

git clone [email protected]:robbiemanson/site-starter.git into a new directory, or download zip
bundle install to install Gems
brew install imagemagick && brew install graphicsmagick for Gulp-powered image resizing
npm install to install NPM packages
Restart terminal

You can now start local development

Replace all instances of examplesite.com with URL of new site
Replace instances of Site Owner
Replace instances of http://stagingAssetURL.com with staging asset URL (e.g. Cloudfront distribution URL)
Replace favicon.png

Configure domain on Route 53 including assets. and staging. subdomains (see one of the other examples e.g. mademountain.com)
Create new whatthedomainis.com S3 bucket with website hosting enabled; follow settings of another functioning example e.g. mademountain.com
Create new www.whatthedomainis.com S3 bucket to function as a redirect to actual bucket just created above; see existing functioning example for settings e.g. mademountain.com
Add s3_id, s3_secret and s3_bucket details in both s3_website.yml files
Create new CloudFront distributions (see existing examples) for both production and staging URLs, add IDs to each of the relevant s3_website.yml files, then replace the Cloudfront URL in head.html
Depending on index/homepage name of the site, may need to update 'Home' title in head.html

Open terminal and run:

$ bundle exec jekyll serve

This will compile the site and recompile as new HTML/file structure changes are made.

Open another terminal window and run:

$ gulp

This will open a new browser tab running Browsersync and auto-reload when any HTML, SCSS, JS or media changes.

Hosted on S3, with CloudFront distribution. Deployed using s3_website.
Deployment config files live in separate production and staging folders at root level
Remember to run s3_website cfg apply before pushing, if any changes are made to either config in s3_website.yml

Ensure asset_url in _config.yml is pointing to correct CloudFront URL
bundle exec jekyll serve > gulp deploy-prep > QA, especially: /pattern-library
s3_website push --config-dir=config_staging --dry-run to check changes before pushing
s3_website push --config-dir=config_staging

Ensure asset_url in _config.yml is pointing to correct CloudFront URL
bundle exec jekyll serve > gulp deploy-prep > QA, especially: /pattern-library
s3_website push --config-dir=config_production --dry-run to check changes before pushing
s3_website push --config-dir=config_production

To resize and minify full sized photos (will take at least a few mins to run):

$ gulp photos

If haven't used Site Starter on your machine before

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Install ruby-install (confirm: ruby-install -V)
```
brew install ruby-install
```
Install Ruby 2.3.3 (confirm: check ~/.rubies, then restart terminal)
```
ruby-install ruby 2.3.3
```
Install chruby (confirm: restart terminal, then chruby)
```
brew install chruby
```
Switch to newly installed ruby 2.3.3
```
chruby 2.3.3
```

Add line to ~/.bashrc or ~/.zshrc

source /usr/local/opt/chruby/share/chruby/chruby.sh

Enable auto-switching of Ruby version by adding these lines to ~/.bashrc or ~/.zshrc

source /usr/local/share/chruby/chruby.sh
source /usr/local/share/chruby/auto.sh