Warwick Cyber Society Website

Hosting

• This is hosted on github pages https://warwickcybersoc.com

Development

• Static assets -> public directory
• Templated pages -> create a new template in the templates folder with the base file of:

{{define "head"}}
# This can be left empty but is needed to prevent errors
{{end}}
{{define "content"}}
# Content goes here
{{end}}

The go program follows the following logic:

• Remove build folder if exists
• Create new build folder
• Copy all assets inside public to build folder
• Load the config.yaml file
• Run every template in the templates directory and add those to the build folder with the config context

Google Calendar API

The Github runner has OIDC set up, but for local development use the service account credentials JSON.

GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\credentials.json" # bash
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\credentials.json" # powershell

Adding new config values

To add new values to a template you need to add the parameter to the Config stuct in config.go e.g.

type Config struct {
    .... Existing data
    NewData string `yaml:"newData"`
}

and then to the config.yaml file

... Existing data
newData: new value

This can then be referenced in the templates by .NewData

Building

There is a github action set to automatically build and publish the site when pushed to the master branch.

Troubleshooting

Variable is an unexported field

Variables in structs need to start with a capital letter to be exported

Other

Feel free to contact the creator on discord (tomsteer) or email (tom@tomsteer.me)

Or the active maintainer, on either discord (vulcanshot) or email (pieromarcelohp@gmail.com)