This repository has been archived on 2025-01-06. You can view files and clone it, but cannot push or open issues or pull requests.

FSFE Website Local Build

This is a collection of scripts, tools and configuration files necessary to build fsfe.org websites locally.

Full instructions can be found in FSFE's wiki: https://wiki.fsfe.org/TechDocs/Mainpage/BuildLocally

Docker based development environment

For convenience local development you may want to use the docker contaienr provided by this repo.

The container contains everything you need to work on the website including serving a preview, building the static pages and the CSS files.

Requirements

Website Dev Instructions

Initial set up

Just run the following command for the initial setup:

./docker-setup.sh

⚠ The command may run some hours, since it does the initial full build of the website.

Development

Spin up the container (⚠ takes some minutes):

docker-compose up

The website should now be available on your machine under http://127.0.0.1:8000/.

Build a single page after changes (e.g. index.de.xhtml):

docker exec \
    --workdir /fsfe-local-build/fsfe.org \
    fsfe-local-build \
    bash ../fsfe-preview.sh ../fsfe-website/index.de.xhtml

Style modifications in fsfe-website/look trigger a re build of the styles. After modifications a page reload shoud show the changes.

Description
This repository has been archived as the tools for locally building the website have been included into the fsfe-website repository (see [Issue 8](https://git.fsfe.org/FSFE/fsfe-local-build/issues/8). Guide and scripts to locally build the FSFE website or single files of it
Readme 80 KiB
Languages
Shell 91.7%
Perl 3.6%
Dockerfile 2.5%
Python 2.2%