UIUC Kappa Theta Tau ·

This is the documentation for Kappa Theta Tau's main website.

Table of contents

• Cloning
• Pushing Changes
• Updating Contacts
• Updating Brothers
• Development _ System Preparation _ Local Installation _ Usage _ Deploy

Cloning

To clone this repo, simply git clone and cd into it.

$ git clone https://github.com/KappaThetaTau/kappathetatau.github.io.git & cd kappathetatau.github.io

Pushing Changes

We are using github-pages to automatically compile and host our website. This means that to update the website, you simply need to push changes to your own branch and make a pull request on Github.

$ git checkout -b <new branch name>
...
<work on the website>
...
$ git add <whatever changes you made>
$ git commit -m "<meaningful commit message"
$ git push origin <new branch name>
<go make your pull request!>

Updating Contacts

Contacts are managed by a CSV file located here. To edit the contacts, simply edit this file

$ open _data/contacts.csv

Updating Brothers

To update the brothers page we use a python script to pull the brother information and images from a google form CSV (https://forms.gle/PsYvMq74Y2J73mUo6).

$ python scripts/update_data.py

Development

System Preparation

1. Ruby 3.0+ (tested through 3.4) — Windows: RubyInstaller (pick a "Ruby+Devkit" build). macOS/Linux: rbenv or RVM.
2. Node 18 — install via nvm (macOS/Linux) or nvm-windows.
3. Bundler — $ gem install bundler
4. Gulp CLI — $ npm install -g gulp-cli (mac users may need sudo)

Windows + Ruby 3.4 note: Ruby 3.4 ships with an outdated default Bundler. If bundle install fails with a DidYouMean::SPELL_CHECKERS error, run bundle _4.0.14_ install once to force the newer Bundler (subsequent bundle calls will pick it up automatically via Gemfile.lock).

Local Installation

1. Clone this repo, or download it into a directory of your choice.
2. Inside the directory, run nvm use.
3. Inside the directory, run npm install.
4. Inside the directory, run bundle install.

Usage

development mode

This will give you file watching, browser synchronisation, auto-rebuild, CSS injecting etc etc. The site will be served at http://localhost:3000.

$ gulp

jekyll

As this is just a Jekyll project, you can use any of the commands listed in their docs. Since Jekyll is installed via Bundler, prefix commands with bundle exec, e.g.:

$ bundle exec jekyll serve --livereload

Contact

• Current Web Chair: Jeff Taylor-Chang · thetatauwebchair@gmail.com
• Previous Web Chair: Dylan Huang · dylan.p.huang@gmail.com