Skip to content

Latest commit

 

History

History
104 lines (70 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

104 lines (70 loc) · 3.95 KB
Raw

Contributing

BRouter is heavily based on the following libraries:

Install dependencies

yarn

Build

#for development
yarn build debug

#for release
yarn build

Develop

yarn serve

Develop with Docker

#to install dependencies
docker-compose run --rm install

#to serve for development
docker-compose run --rm -p 3000:3000 serve

#or
docker-compose up serve

Translations

TL;DR if you contribute to BRouter and add some translatable content, please make sure not to modify anything in locales folder, except locales/en.json. Full explanation below.

How internationalization works

BRouter is translated using i18next library, via command gulp i18next. It extracts translatable elements into locales/en.json file (English version). (Note that unused translation keys or keys not referenced in keys.js might get removed automatically. Make sure to commit any changes first before running this, and only amend the previous commit after checking the diff carefully.)

As soon as this file is modified, it must be uploaded by the maintainers to Transifex (manually) with the command yarn push-transifex (maintainers need to install the new cli client).

Anyone can then translate BRouter directly on Transifex platform.

From time to time (eg. when preparing releases), we can update translated content with the command yarn pull-transifex. It will overwrite all JSON files in locales directory.

License

BRouter is licensed under MIT. Please make sure before adding any library that it is compatible with that. (GPL licenses are incompatible for instance).

Tests

Jest is used for unit tests.

Tests are located in the tests directory in the project root. The idea is to mirror the structure in the js directory and to have a test file for each file there with the same name, but with a .test.js suffix (which is how tests are found).

Examples for running tests (see CLI Options):

# run all tests
yarn test

# watch to run affected tests for changed files while developing
yarn test --watch

# run specific test file only (while watching or without)
yarn test --watch tests/format/Gpx.test.js

# run a single test by name (regex for name passed to describe/test functions)
yarn test --verbose -t="2-locus"

Layers

Vector Tiles / DEM

MapLibre GL JS and MapLibre GL Leaflet are used to render vector tile layers. Their bundles are only loaded if the first mvt layer is actually added to the map.

  • layers/mvt folder for layer descriptions (*.geojson) and local styles (not a requirement)
  • "type": "mvt" in layer description
  • "url": is for style.json (instead of tile URL), either as:
    • file name of local style file without .json (= key in dist/layers.js bundle),
      • suggested file naming convention: <layer-id>-style.json
        (stored next to description <layer-id>.geojson)
    • URL to remote style
  • access token for tile URLs
    • configure in keys.js / keys.template.js:
      <provider>: 'mykey'
    • add template to tile url in style source, e.g.:
      ...?access_token={keys_<provider>}
    • when also appended after ? to local style url, the layer is not added when key is not defined:
      "url": "<layer-id>-style?{keys_<provider>}"