Workshop Series: GitHub, GitHub Actions (with Quarto) and ShinyApps.io
Course Outline
Preparation and installation instructions
Learning Objective: Set up GitHub account and ensure the tools we need are working on your machine
Instructions: Preparation and installation instructions
External Resources:
- BC Stats: Introduction to Version Control with Git & GitHub > BCGov GitHub Organization
- BC Developer Guide: BC Government organizations in GitHub
Workshop 1. GitHub Collaboration Workflows
Learning Objective: Practice key steps for remote code hosting and collaborating in GitHub by using branches, opening pull requests (PRs), reviewing PRs, and merging changes
Instructions: GitHub Collaboration Workflows
External Resources:
- BC Stats: Introduction to Version Control with Git & GitHub > Remote Code Hosting and GitHub
- Software Carpentry: Version Control with Git (specific sections)
Workshop 2. GitHub Pages and Actions
Learning Objective: Explore GitHub Pages and Actions and how they work together to publish the site. Practice by publishing a Quarto site to our own GitHub account. Note: These are advanced topics. We are hosting this give some insight into how the pieces fit together but these tasks are not indicative of what you will be required to do in the new system. Instructions: GitHub Pages and Actions
External Resources:
- GitHub: Creating a GitHub Pages site
- Quarto: Publishing > GitHub Pages
Workshop 3. Deploying to Shinyapps.io
Learning Objective: Understand how to deploy a Shiny app using ShinyApps.io, practice deploying an app, making a change, and registering and adjusting permissions from the dashboard. Instructions: Deploying to Shinyapps.io
External Resources:
- Shinyapps.io: User Guide > Getting Started
Acknowledgements
This instruction material is sourced and adapted from the following places:
- The BCGov “Workshop: Introduction To Version Control With Git and GitHub” Copyright © Province of British Columbia and made available under the Creative Commons Attribution 4.0 International licence.
https://github.com/bcgov/ds-intro-to-git
- The Software Carpentry Foundation (now The Carpenties). All Software Carpentry, Data Carpentry, and Library Carpentry instructional material is Copyright © Software Carpentry and made available under the Creative Commons Attribution licence.
Daisie Huang and Ivan Gonzalez (eds): Software Carpentry: Version Control with Git. Version 2016.06, June 2016, https://github.com/swcarpentry/git-novice, 10.5281/zenodo.57467.
- Joe Cheng “Kmeans example” Copyright © Joe Cheng and RStudio. https://github.com/rstudio/shiny-examples/tree/main/050-kmeans-example
In addition, tutorials and documentation are linked and credited throughout.