Skip to content

ASSERT-KTH/assert-research-website

Repository files navigation

ASSERT Research — Website

The official website for ASSERT Research, a non-profit association (ideell förening) based in Stockholm, Sweden, advancing scientific research and development in software technology.

A static site, deployed to GitHub Pages on the custom domain assert-research.org. The main site is in English; only the bylaws are published in both English and Swedish.

Project structure

.
├── index.html              # the site — English, edited directly
├── bylaws-en.html          # English bylaws — GENERATED from bylaws-en.md
├── bylaws-sv.html          # Swedish bylaws — GENERATED from bylaws-sv.md
├── assets/
│   ├── css/
│   │   ├── main.css         # entry point — @imports the modules below
│   │   ├── theme.css        # design tokens: colours, type, spacing (edit here)
│   │   ├── base.css         # reset + base element styles
│   │   ├── layout.css       # header, footer, containers, grids
│   │   ├── components.css   # buttons, hero, cards, members
│   │   └── bylaws.css       # styling for the legal document pages
│   ├── js/
│   │   └── main.js          # small UI helpers (footer year)
│   └── img/                 # optimised logos, favicon, board avatars
├── scripts/
│   └── render-bylaws.js     # renders bylaws-*.md → bylaws-*.html
├── bylaws-en.md / bylaws-sv.md   # authoritative bylaws source (Markdown)
├── CNAME                    # custom domain for GitHub Pages
└── .github/workflows/deploy.yml

Editing content

  • All visible text lives directly in index.html, including the board and founding members.
  • Colours / fonts / spacing are design tokens in assets/css/theme.css. The palette is built around the Swedish flag's blue and yellow.

bylaws-en.html and bylaws-sv.html are generated — do not edit them by hand (see below).

Bylaws pages

The bylaws are authored in Markdown (bylaws-en.md, bylaws-sv.md) and rendered into styled, standalone pages (bylaws-en.html, bylaws-sv.html) by scripts/render-bylaws.js. Each page reuses the site's header and footer, which are extracted from index.html between the @partial:header / @partial:footer comment markers — so the shared chrome has a single source.

The shared header and footer are in English on both bylaws pages; only the legal body text differs by language. A link in the page header switches between bylaws-en.html and bylaws-sv.html.

  • Edit the text in the .md files, then run npm run build.
  • Edit the document styling in assets/css/bylaws.css.
npm run build        # renders bylaws-*.html

Local preview

Because pages use absolute paths (/assets/...), serve from the project root:

npm run serve        # builds the bylaws pages + serves at http://localhost:5173
# or any static server, e.g.:  python3 -m http.server 5173

Deployment

Pushing to main triggers .github/workflows/deploy.yml, which runs the build (rendering the bylaws pages) and publishes the site to GitHub Pages.

One-time setup:

  1. Repo → Settings → Pages → Build and deployment → Source: GitHub Actions.
  2. The CNAME file pins the custom domain assert-research.org.
  3. In Cloudflare DNS, point the domain at GitHub Pages:
    • CNAME (or apex A/AAAA) records to GitHub Pages.
    • For the apex assert-research.org, add A records to GitHub's IPs (185.199.108.153, .109.153, .110.153, .111.153) or a CNAME flatten to <user>.github.io.
    • Set the Cloudflare proxy to DNS only (grey cloud) initially so GitHub can issue its TLS certificate, then enable Enforce HTTPS in GitHub Pages settings.

Logos

Source artwork: public/assert-research-logo-6600px.png. Optimised variants in assets/img/ (logo.png, logo@2x.png, white logo-white.png for the dark footer) were generated with ImageMagick. To regenerate:

magick public/assert-research-logo-6600px.png -resize 1400x assets/img/logo.png
magick public/assert-research-logo-6600px.png -resize 2200x assets/img/logo@2x.png
magick public/assert-research-logo-6600px.png -resize 1100x \
  -channel RGB -evaluate set 100% +channel assets/img/logo-white.png

About

Home page for the non-profit organization ASSERT Research

Resources

Stars

Watchers

Forks

Contributors