Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

Static (Hugo) reincarnation of STC-Rec.TamaToledo.org

Notifications You must be signed in to change notification settings

SummittDweller/stc-rec.tamatoledo.org

Repository files navigation

STC Rec - Hugo Static Site

Development

Clone

Clone the project to your local workstation using:

git clone --recurse-submodules https://github.com/SummittDweller/stc-rec.tamatoledo.org.git

The use of --recurse-submodules ensures that you get all active themes and any other Git submodules that are part of the project.

Using GitHub Desktop

If you clone in some other manner without the --recurse-submodules flag, as is the case when using GitHub Desktop, be sure you also run the following:

cd ~/Documents/GitHub/stc-rec
git submodule init
git submodule update

If you don't do this your submodule(s), and therefore your bootstrap_bp_hugo_theme, will be EMPTY!

Create a New Branch

Use the following syntax to create a new local branch, and tracked upstream branch, on your workstation before you begin to make changes.

git checkout -b <new branch name>

Developing Without Docksal

Docksal is nice, but it's really overkill when it comes to developing with Hugo. All you really need is an up-to-date version of Hugo installed on your host. Then, to develop a Hugo project you need Hugo running in a server mode (Hugo Quickstart guide for more details).

hugo server

hugo server starts a local Hugo stack making the project available at localhost:1313. The site updates as you edit, you don't even have to reload the page to see your changes.

NOTE: once started, the hugo server will run, blocking the console. Kill it with Ctrl-C, when you are done.

Pushing to Production

This project has a special Dockerfile named push-update-Dockerfile and it goes hand-in-hand with a provided script named push-update.sh. When executed from the host's project directory...

  • The script will ensure that the current local branch of the project is checked out
  • It runs Hugo on the host to compile the project to the host's ./public directory
  • That directory is then copied into a new Nginx Docker container
  • The resulting Docker image is pushed to my DockerHub account
  • Watchtower_, running on the production server, keeps watch for changes in DockerHub to summittdweller/compassrose:latest, and pulls in that image whenever changes are detected.

That essentially completes a push-to-production workflow.

The whole process can be run from the command-line like so:

cd ~/Documents/GitHub/compass-rose-band
./push-update.sh

Videos

Videos should be opened in QuickTime and exported as 480p for proper size, then save the converted .mov file to https://images-summittdweller.nyc3.digitaloceanspaces.com/CRB-Videos/ in my DigitalOcean Spaces.

About

Static (Hugo) reincarnation of STC-Rec.TamaToledo.org

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages