Creating & synching new repo from the ultimate-jekyll template
- Navigate to https://github.com/itw-creative-works/ultimate-jekyll/ and click Use this template or just generate it here.
- In the next window, name the new repository and choose an organization to host the repository.
- Click 1 Branch in the middle bar and then the pencil icon next to
template
in the next window. Name it master
.
- Open the newly created repository on GitHub and click Open in Desktop then choose location using GitHub desktop.
- In the repo's settings add a secret called
GH_TOKEN
and paste a GitHub token that has write permissions for this repo.
- Open Terminal and do the following commands or simply
npm run template:setup
- Go back into GitHub desktop on the new repo and press Push in top bar.
- Initialize the new repo by entering this command in Terminal:
Get changes from the ultimate-jekyll template
Perform the following steps or simply run npm run template:update
- Open GitHub Desktop and select your project (not ultimate-jekyll, the project that uses ultimate-jekyll).
- Change current branch to
template
.
- Then press Fetch upstream.
- Then Pull upstream.
- Change current branch to
master
.
- Click Choose branch to merge into
master
from the branch dropdown (at the bottom).
- Select
template
from the list.
- Click the blue Merge
template
into master
button.
- Press Push origin in the top right.
How to properly use the template
This repo will only ever receive changes to files located in master
folders. You can safely customize any file in app
folders. For example:
- Do NOT edit:
assets/_src/js/master/main.js
- Do edit:
assets/_src/js/app/app.js
You can always run npm run template:update
to get all the latest updates from the Ultimate Jekyll template but be sure to check if there were any breaking changes.
Run a local https server
- Execute:
npm run create:cert
npm run prototype:https
- Press cmd + option + i on the webpage that opens.
- Go to Security tab and press Show certificate.
- Drag the certificate to your Desktop then double-click it
- Double-click it when it has opened in keychain
- Open the trust dropdown and change it to always trust
Things to regularly update on ultimate-jekyll
- ./special/master/misc/master-service-worker.js = instances of Firebase SDKs being loaded
Things to regularly update on web-manager
- Dependencies in package.json
Reference