Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 3.41 KB

README.md

File metadata and controls

46 lines (27 loc) · 3.41 KB
Raw

The Datenanfragen.de website

This repository contains the source code for the Datenanfragen.de website.

Datenanfragen.de is an open source project by Datenanfragen.de e. V., a registered non-profit from Germany. We have made it our mission to help you exercise your right to privacy.
Through our website, we offer a generator for GDPR requests as well as access to our company and supervisory authority database (see this repository for the source behind this data) and comprehensive articles on the GDPR and privacy in general.

A screenshot of the datarequests.org homepage

Live versions of the website are currently available in German, English, French, Spanish, and Portuguese.

Development

Datenanfragen.de is designed as a static website, running on Hugo and Preact.

To build the project locally for development, follow these steps:

  1. Install Yarn and the extended(!) version of Hugo.
  2. Clone the repo and run yarn in the root directory of the repo to fetch all required dependencies.
  3. Run the deploy script (./deploy.sh) to fetch and prepare the required resources from our data repository.
  4. Open two terminal windows. In the first, run yarn dev to start the Webpack file watcher which will automatically build the JS files. In the second one, run hugo server to have Hugo continously build the actual website and the SCSS.
  5. Now the website should be served by Hugo on multiple ports, starting from 1313, for the different language versions.

The production builds are done automatically by CircleCI using the deploy.sh script and deployed using dattel, our own static hosting solution (split into a server and client).

For testing, we use CircleCI in combination with Cypress (see more on our browser tests here). We previously used BrowserStack who kindly let us use their services.

Contributing

First of all, thank you very much for taking the time to contribute! Contributions are incredibly valuable for a project like ours.

We warmly welcome issues and pull requests through GitHub.

Please be aware that by contributing, you agree for your work to be released under the MIT license, as specified in the LICENSE file.

If you are interested in contributing in other ways besides coding, we can also really use your help. Have a look at our contribute page for more details.

Translations

While you can just contribute translations through this repository, an easier way is through the localisation platform Weblate. We manage our translations through them. There, you can easily help us translate—be it a couple of strings or whole components.