Name: software.wikimedia.de
Owner: Wikimedia Deutschland e.V.
Description: The software.wikimedia.de website
Created: 2017-01-19 23:44:20.0
Updated: 2018-05-24 15:26:14.0
Pushed: 2018-05-24 15:26:14.0
Homepage: https://software.wikimedia.de
Size: 2415
Language: HTML
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This repo contains the resources of the software.wikimedia.de website.
This website is meant to give people not familiar with our department an idea of who we are, what we do and how we do it. The target audience that motivated its creation is potential hires. While the site can be used to cater to other needs as well, the hiring one should always be kept in mind.
You can treat the website as if it where a wiki. In fact, the previous version of the site was on a wiki. Use your own best judgement. If you are fixing a typo, just push to master. If you think it warrants a second eye or you are actively looking for feedback, create a pull request. Everyone part of the WMDE GitHub organization can merge pull requests.
The main authors or the existing content are @samu-wmde and @JeroenDeDauw, so these are the primary suspects for feedback.
Changes to this git repo do not automatically get deployed. You can just leave your changes as they are, to be deployed whenever the next deployment happens, or you can pester either @addshore or @JeroenDeDauw to do a deployment.
Running the site requires PHP 7.0 or later.
After cloning the repo, run composer install in the root directory.
For running the application, execute php -S 0:8000 -t web in the root directory. This makes the site
available at http://localhost:8000/ in your browser. For development, you probably want to use the
development entry point url:8000/index.dev.php, which enables debug mode and disables HTTP caching.
To run the application from Docker (does not require having PHP installed):
docker run --rm --interactive --tty --network="host" --volume $PWD:/app -w /app \
--volume ~/.composer:/composer --user $(id -u):$(id -g) composer php -S 0:8000 -t web
There are a few smoke tests that can be run with composer ci.
The website uses the Silex PHP micro-framework and the Twig template engine. Typical modifications to the content only require modifying the templates, which means that you can contribute to the website without knowing any PHP.
The HTML of the website can be found in app/templates/.
layout.html contains the non-page-specific stuff such as menu, footer and JS/CSS loadingpages/ contains one file per page, matching URL structure (plus .html)sections/ contains page sections used on multiple pages via the Twig include thingResources such as JS, CSS and images can be found in web/.
The layout is based on Twitter Bootstrap and uses structure borrowed from the Modern Business bootstrap template.