www/README.md
2025-06-07 15:35:43 +02:00

57 lines
1.8 KiB
Markdown

# CCCB Website
This is the website of the CCCB.
![CCCB logo](assets/img/logo.png)
## 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/>
To ready your site for upload, run `./build.sh`, which also generates `all.ics`
and adds the calendar table to `index.html`.
Every change you make on the project will be reflected in your browser
as long as `hugo serve` is running.
## 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 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` should work
- Python including required packages will be available, so the `build.sh` should work without a venv
- 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).