Yohoho! This repository contains the source code for the Pirates website. The website's main purpose is to inform freshmen about our student group and what we're doing with them in the o-week.
This website is built with Next.js (on top of React) and compiles to a bunch of HTML, JS, etc. files that are statically hosted on GitHub Pages.
We aim to use modern but stable tooling to simplify maintainability. Tools should be updated regularly but use stable / LTS releases if available.
The website is built and tested with
- Node.js 16 for compilation
- pnpm 7 for package management
- lots and lots of JS packages
Make sure node 16 and pnpm 7 are installed.
First, install all dependencies using
pnpm install
You can start a local development server (with live preview etc.) with
pnpm dev
Before committing, please make sure that the site can be built using
pnpm build
- Although most of the content is new or has been revised, much of the content (especially images!) have been copied from the old Jekyll-based site
- The visual style of our website is heavily inspired by the amazingly beautiful demo site from parallax JS. Some of our assets were also copied from there
The main
branch is automatically deployed to our production website, see
.github/workflows/deploy-main.yml
for
further details.
The develop
branch is automatically deployed to
pirates.maxschweik.art, see
.github/workflows/deploy-develop.yml
for
further details.