aprl/www
Watch
0
0
Fork
You've already forked www
 0
forked from cccb-website-team/www
Code Pull requests Activity
www/README.md
April John 75ae1c30a2 Merge branch 'main-staging' into staging
2026-08-28 16:00:55 +02:00

2.3 KiB
Raw Blame History

CCCB Website

This is the website of the CCCB.

CCCB logo

Getting started

  1. Get Hugo: https://gohugo.io/getting-started/installing

  2. Clone this repo (--recursive is needed to check out submodules)

    git clone --recursive https://git.berlin.ccc.de/cccb-website-team/www.git cccb-website

  3. Switch directory

    cd cccb-website

  4. Run hugo webserver

    hugo serve

  5. Point your browser to: http://localhost:1313/

Every change you make on the project will be reflected in your browser as long as hugo serve is running.

The "Nächste Veranstaltungen" calendar on the home page is rendered by Hugo via the calendar shortcode, which fetches all.ics client-side. all.ics is generated from the individual event pages by ./tools/merge_cals.py. To preview the fully-built site (including all.ics), or to ready the site for upload, run:

./build.sh

build.sh runs hugo, generates all.ics, and copies it into public/. It depends on Python with the icalendar, python-dateutil, and pytz packages. Inside nix develop these are provided automatically.

To build with nix: nix build '.?submodules=1#production-content'

Making a change

  1. Use your local dev setup (see Getting started) or via the Forgejo editor.
  2. Make your change in staging branch.
  3. Commit (and push) your change.
  4. GitHub Actions is running the release workflow.
  5. Create a merge request to merge changes from staging to production branch. Ask somebody to check merge request or if small change, merge yourself.
  6. GitHub Actions is running the release workflow.
    • If successfull, check Website if change is correct.
  7. Profit!

Nix stuff

  • After entering the shell with nix develop, hugo is available and hugo serve and ./build.sh should work
  • You can build the staging and production builds with nix build .#staging-content and nix build .#production-content
  • Do not update the nixpkgs branch - 25.05 contains a newer hugo version that is incompatible with the theme (last checked June 2025)

Made with ❤️ and Hugo.