Contribute

The documentation in this file is only necessary if you will contribute to the code.

If you want to install or deploy the website, see INSTALL.md instead. If you're interested in the build process, see BUILD.md.

Technologies

Technologies used in the application:

Components: Bulma / bulma-start
Data loading: topojson, d3-fetch
State management: d3-dispatch
Data visualization:
- projections: d3-geo
- labels: polylabel (copied here to have ESM), tinyqueue

Get the code using git (install git first if necessary):

git clone https://github.com/severo/pesticides_website.git

Then enter the cloned directory and install the npm dependencies (install npm first if necessary):

cd pesticides_website
npm install

Note that most of the dependencies are for development only.

The repository is composed of three main parts:

src/: the source code of the website, in HTML (with mustache placeholders), JS and SASS.

Development takes place here.
docs/: the compiled code, ready to be deployed. Note that generally dist/ or build/ are used, but using docs/ allows to automatically deploy the website on GitHub Pages without any hassle.

This directory is completely created at build time, and is versioned to make it easier to deploy on GitHub Pages. It should never be modified by hand.
files at the root of the repository: doc files, npm dependencies, configuration files.

Only modify if you want to improve the software project management.

Define if D3.js and Bulma are dev dependencies or not
give information on the expected coding style
explain what to test with unit tests
explain what to test with integration tests
pass configuration values to the index.html file using mustache placeholders (for example {{config.svg.height}})