UCSD-SUMS.github.io

This repository contains the files that generate the SUMS website.

Built with Hakyll

The most up-to-date technical documentation is on the wiki.

Installation

TL;DR

export GIT_LFS_SKIP_SMUDGE=1
git clone https://github.com/UCSD-SUMS/UCSD-SUMS.github.io
curl -sSL https://get.haskellstack.org/ | sh
npm install -g yarn
cd UCSD-SUMS/github.io
yarn install
npm run stackSetup
npm run watchSite

Individual Steps

• Install Stack and Node/NPM.

• Use Stack to install GHC:

stack setup

• Clone this repository (Note: binary files such as images and pdfs are stored in git-lfs. The first line prevents you from cloning all of these files.)

export GIT_LFS_SKIP_SMUDGE=1
git clone https://github.com/UCSD-SUMS/UCSD-SUMS.github.io

• Install NPM and use Yarn to install frontend dependencies

npm install -g yarn
yarn install

(This takes care of building/generating minified JS files for certain parts of the site.)

• Start the local webserver

npm run watchSite

Once this has finished, you can then navigate to localhost:8000 to see the site.

There may be issues on Windows-based systems. See the wiki for more information.

Editing Existing Events

All events are written in markdown files and kept in the events subfolder. If you aren't familiar with markdown syntax, you can find most of what you need here.

To edit an event, first sign up for a Github account and ensure you have read/write access to the repository.

You can then navigate directly to the relevant file using Github's web UI, click the edit button on that file, and commit your changes directly without having to download the repository.

Adding a New Event

Use the Event Generator Tool to create a markdown file to start with. You can link to images using standard markdown syntax - just upload images to the static folder through Github, then include them using something like [image alt text](static/imageName.png).

Adding a New Page

To add an entirely new page, contact the web coordinator!

Other Notes

All changes should be pushed to the hakyll branch, which kicks off the automated build and deploy process through CircleCI.