Skip to content

Latest commit

 

History

History
117 lines (82 loc) · 5.44 KB

README.md

File metadata and controls

117 lines (82 loc) · 5.44 KB
Raw

Germany Extractive Industries Data and Information

NEWS

End of development

The development of this repository was ended. There was developed a new website. All data were transmitted over there. Url still the same. If you wish to source code of new webpage (e.g. for using this in another country) please contact d-eiti sekretariat via email. We will provide you a current state of http://www.rohstofftransparenz.de/ webpage.

Contact email adress: sekretariat@d-eiti.de

What

Germany extracts natural resources such as oil, gas or building materials on its lands. This economic activity is a source of revenue for the country, the federal states (Bundesländer) as well as for local municipalities.

This repository contains the code for http://www.rohstofftransparenz.de/en/, which is a website that includes both content information as well as visualized and raw data on the German extractive sector. The website provides a valuable resource for data and information analysis and visualizations that can be readily understood and accessed by the public for re-use through other media and applications. The repository contains a bilingual realization of the website and builds on the open source code from the U.S. EITI implementation.

Why

This effort is part of the German implementation of the international standard called the Extractive Industries Transparency Initiative (EITI). EITI is a global coalition of governments, companies and civil society working together to improve openness and accountable management of revenues from natural resources. For more information on the German process of implementing the EITI standard, see the D-EITI homepage.

Until Germany publishes its first EITI report in August 2017 the website http://www.rohstofftransparenz.de/en/ will constantly growing content and data wise.

About this website

This is the development of the D-EITI report website, a fork of the [D-EITI homepage] (https://www.d-eiti.de/). Most of the source code was re-used and some was newly implemented, to see a journal of the technical challenges we faced performing this adaptation see journal.md.

Data

The data catalog explains what most of the data is and where it came from. See the data directory for more detailed info and instructions on updating the data.

Running the Site

This site is made with Jekyll. To run it locally, clone this repository then:

Note: You need to have ruby installed on your machine

  1. Get Jekyll and the necessary dependencies: bundle install
  2. Install all node dependencies: npm install (if you are getting error related to node-gyp rebuild ignore and continue)
  3. Set the $NODE_ENV to dev: export NODE_ENV=dev
  4. Package js files with webpack: webpack --watch
  5. Run the web server: bundle exec jekyll serve (or just jekyll serve if you have Jekyll installed globally)
  6. Visit the local site at http://localhost:4000

Deployment

This site is deployed on STRATO, and data is updated through an Admin panel that lives in a separate app written in Node.js, you can see its source code at https://github.com/PfeffermindGames/resource-map-backend. For each year we have two charts.

The site is build with npm run prod:build, and is served by a NGINX server.

Styleguide

npm install --dev
npm run init-styleguide
cd styleguide-template && npm install
cd ..
npm run watch

Code Style

We use Hound CI to enforce SCSS and JavaScript formatting conventions on new commits. You can run both of the linters with:

npm run lint

This runs both of the linters below in series.

JavaScript Linting

Hound uses jshint, which you can install as part of the npm package's devDependencies with:

npm install --dev

Or you can install it globally with npm i -g jshint. Then, to lint the JavaScript, run:

npm run lint-js

SCSS Linting

Hound uses scss-lint, which you can install with gem install scss_lint if you haven't already run bundle install to get Jekyll and its dependencies. To lint the SCSS files, run:

bundle exec scss-lint -c .scss-lint.yml

or simply:

npm run lint-scss

Languages (DE/EN)

Edit multilanguage strings here.

Contributing

Content and feature suggestions are welcome via GitHub Issues. Code contributions are welcome via pull request, although of course we cannot guarantee your changes will be included in the site.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.