mxmehl
/
fsfe-local-build
mirror of https://git.fsfe.org/FSFE/fsfe-local-build.git
1
0
Fork 0
Code Issues Releases Wiki Activity
32 Commits 3 Branches 1 Tag 68 KiB
Shell 91.7%
Perl 3.6%
Dockerfile 2.5%
Python 2.2%
Go to file
delliott 40855e2d7b Merge pull request 'Modify to better match https://git.fsfe.org/FSFE/fsfe-website/pulls/4371' (#7) from status-improvements into master 
Reviewed-on: https://git.fsfe.org/FSFE/fsfe-local-build/pulls/7
 		2024-08-14 12:10:35 +00:00
status change ignoring and keeping of folders to prevent dirty directories when dealing with the fsfe-website git and its .gitignore 2018-11-28 13:09:15 +01:00
.gitignore ignore optional php error log 2020-10-02 14:50:01 +02:00
Dockerfile Removes less from docker (#5) 2019-06-12 16:47:54 +02:00
LICENSE adding README and license 2016-11-14 02:09:44 +01:00
README.md Add a docker dev setup (#3) 2019-04-29 18:18:59 +02:00
config.cfg.docker Add a docker dev setup (#3) 2019-04-29 18:18:59 +02:00
config.cfg.sample fix paths 2018-11-28 13:15:21 +01:00
create-mime.assign.pl initial commit 2016-11-13 20:35:50 +01:00
docker-cmd.sh Removes less from docker (#5) 2019-06-12 16:47:54 +02:00
docker-compose.yml Add a docker dev setup (#3) 2019-04-29 18:18:59 +02:00
docker-setup.sh Replace /bin/bash with /usr/bin/env bash (#4) 2019-05-26 11:05:49 +02:00
fsfe-build.sh Modify to bettwer match https://git.fsfe.org/FSFE/fsfe-website/pulls/4369 2024-08-14 10:09:22 +02:00
fsfe-preview.sh create destination directory if necessary. Also rename SVN->Git 2021-05-17 14:27:43 +02:00
lighttpd-fsfe.conf.sample fix paths 2018-11-28 13:15:21 +01:00
pywebserver-fsfe.py adding option to use python simplehttp webserver module which doesn't require users to install lighttpd 2016-12-15 17:39:39 +01:00

README.md

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.