Research Group Static Website

This is a static website for a research group, hosted as GitHub Pages.

This website is designed to update its contents every 30 minutes based on a Google Sheets document with scheduled GitHub Actions jobs.

How does this website work?

This project is designed to update its website contents in docs folder every 30 minutes with scheduled GitHub Actions jobs defined in this file. The website contents also get updated when you push something into the website.

Do NOT directly modify the contents in docs folder, since the contents of that folder gets auto-updated every 30 minutes.

How to upload static files to this website

If you need to upload image files or any other static files to use in the website to this repository, please put your files in assets folder. All files in the folder will be copied to docs/assets when other website contents get updated.

How to create your own website from this

1. Fork this repository to your account.

2. Configure the repository to publish a GitHub Pages site from a docs folder on the master branch. Read this document if you need help.

3. Configure a custom domain for your website if you need to. Read this document if you need help.

4. Create a new Google Sheets document to store your website contents. Set DATA_URL value in the file builder/config.py. Follow the instructions below for this.

5. Get a valid Google API key to use when downloading the website contents. Set the key as a encrypted secret API_KEY. Follow the instructions below for this.

6. Voilà! You have

Create a data source document

This project automatically downloads contents for the website from a Google Sheets document. Set URL of your document as a value for DATA_URL in the file builder/config.py.

An example document is available at here.

To create your own document, follow the instructions below.

1. Use this link to make a copy of the example Sheets document.

2. Set your document's sharing settings as: Public on the web - Anyone on the Internet can find and view. Read this document if you need help.

3. Copy the URL of your document and paste in the file builder/config.py as a value of DATA_URL.

Get a Google API Key

The website builder in this project needs a valid Google API key to download website contents from the Google Sheets document. Add the key to the repository as a encrypted secret value API_KEY.

1. Get an API key from Google Developers Console. Read this answer from a question in Stack Overflow to see how to create an API key and enable its use for Google Sheets APIs.

2. Set your API key as a secret value API_KEY. Read this doucment to see how to add encrypted secrets for a GitHub repository.

Acknowledgements

This work was supported and funded by JinYeong Bak. The developer of this repo is Jeongmin Byun.

Tips

• How to do line breaks in markdown
  • Two spaces at the end of the line (recommended, https://stackoverflow.com/a/33191810)
  • One empty line between lines
  • Reference: https://gist.github.com/shaunlebron/746476e6e7a4d698b373
• How to update the webpage
  • Go to Actions page
  • Click Run workflow button