forked from cccb-website-team/www
83 lines
2.8 KiB
Markdown
83 lines
2.8 KiB
Markdown
# CCCB Website
|
|
|
|
This is the website of the CCCB.
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
1. Get Hugo: <https://gohugo.io/getting-started/installing>
|
|
2. Clone this repo (`--recursive` is needed to check out submodules)
|
|
|
|
```shell
|
|
git clone --recursive https://git.berlin.ccc.de/cccb-website-team/www.git cccb-website
|
|
```
|
|
|
|
3. Switch directory
|
|
|
|
```shell
|
|
cd cccb-website
|
|
```
|
|
|
|
4. Run hugo webserver
|
|
|
|
```shell
|
|
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"* table on the home page and the calendar under `/verein/calendar/` are rendered in the
|
|
browser by `assets/js/upcoming.js` and `assets/js/calendar.js`. Both fetch `/calendars/all.ics`, which is **not**
|
|
generated by Hugo and is not part of this repo — it is published separately on the web server. Without it both tables
|
|
stay empty. Download the published calendar into `static/`, which Hugo serves under the same path, and they work
|
|
locally, under `hugo serve` as well as in a built site:
|
|
|
|
```shell
|
|
mkdir -p static/calendars
|
|
curl -o static/calendars/all.ics https://berlin.ccc.de/calendars/all.ics
|
|
```
|
|
|
|
The file is only there to look at the site, it is not checked in. Download it again whenever you want the events that
|
|
are currently published.
|
|
|
|
Hugo does generate an `.ics` feed per section (for example `/veranstaltungen/index.ics`) from the `dtstart`, `dtend`
|
|
and `rrule` front matter of the pages in `content/veranstaltungen/`, using the `.ics` templates under `layouts/`.
|
|
|
|
To build the site for upload, run:
|
|
|
|
```shell
|
|
./build.sh
|
|
```
|
|
|
|
This deletes `public/` and runs `hugo` with the parameters from `.hugo-params`.
|
|
|
|
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.~~
|
|
- If successful, check [Staging Website](https://staging.berlin.ccc.de/) if change is correct.
|
|
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](https://berlin.ccc.de/) 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](https://gohugo.io).
|
|
|