This monorepo hosts frontend packages and applications of the GlobalFishingWatch ecosystem.
All of them availables with the @globalfishingwatch/ prefix:
| api-client | JS library to simplify GFW API login and resources fetch |
| api-types | API typescript schema definitions |
| data-transforms | Set ot shared tools for data transformations |
| datasets-client | A set of utils for handling api datasets |
| dataviews-client | A set of utils for merge, combine and consume api dataviews into the apps |
| deck-layer-composer | Map integration of the deck-layers |
| deck-layers | Deck classes for GFW layers |
| deck-loaders | Deck loaders for GFW layers |
| fourwings-aggregate | Logic to turn fourwings tiles or cells into meaningful values for the frontend |
| i18n-labels | GFW shared translations |
| layer-composer | Orchestrates various Layer Generators to generate a Mapbox GL Style document |
| ocean-areas | Small library to get ocean area / eez names by viewport or by text search |
| pbf-decoders | PBF custom responses parsers |
| react-hooks | Set of hooks to use libraries easily in react |
| timebar | Timebar component, not many more to say |
| ui-components | Reusable atoms components kit |
| api-portal | Api documentation portal |
| data-download-portal | The place to download datasets |
| fishing-map-e2e | Cypress e2e testing for the map |
| fishing-map | Version 3.0 of the fishing map project |
| image-labeler | Labeling tool for satellite images |
| port-labeler | Labeling tool for ports |
| user-groups-admin | Tool to manage user groups with ease |
| vessel-history | Vessel history app |
To create a new application using a template with sidebar + map + timebar just run:
nx workspace-generator app [your-name]nx start [your-name]| config | Shared generic build config as tsconfig, rollup or postcss |
| linting | Define eslint prettier and stylelint configurations |
We maintain our own forks of Mapbox GL to handle gridded temporal data (see temporalgrid branches on both repos)
See: From WebGL triangles to Dataviews - Organizing visualization of data at GFW
The repo is using yarn workspaces so npm is not suported yet, to install yarn follow this instructions
For all packages:
yarn add [package] -WOnly for a specific package
cd apps/[you-app]
yarn add [package]To install all packages dependencies just run:
yarnNx handles every app or library by its own project.json file, see for example fishing-map:
nx start [app-name]To ensure git flow process, master branch will be protected to force opening PR to every change desired. For now, the only one strong recommendation is to tag every PR to prepare the changelog automatically.
To test all packages builds process run, useful to test everything works well before publishing.
nx build [app-name] --parallelTODO
https://gateway.api.dev.globalfishingwatch.org/swagger#/
To replicate the prod environment where the apps run on a path (not the root) and with https we use a nginx proxy that runs on SSL and maps all the incoming request to its corresponding app.
- Generate the ssl certificates:
./generate-certificate.sh- Set the proper environment variables to build each app, lookt at the build.env.sample file for reference:
cp apps/fishing-map/.build.env.sample apps/fishing-map/.build.env
# Edit apps/fishing-map/.build.env and save your changes
cp apps/vessel-history/.build.env.sample apps/vessel-history/.build.env
# Edit apps/vessel-history/.build.env and save your changes
cp apps/api-portal/.build.env.sample apps/api-portal/.build.env
# Edit apps/api-portal/.build.env and save your changes
cp apps/fourwings-explorer/.build.env.sample apps/fourwings-explorer/.build.env
# Edit apps/fourwings-explorer/.build.env and save your changes- Build the apps:
npx env-cmd -f apps/fishing-map/.build.env nx build fishing-map --parallel
npx env-cmd -f apps/vessel-history/.build.env nx build vessel-history --parallel
npx env-cmd -f apps/api-portal/.build.env nx build api-portal --parallel
npx env-cmd -f apps/fourwings-explorer/.build.env nx build fourwings-explorer --parallel
nx run-many --target=docker-prepare --all- Spin up docker compose:
docker-compose up -d- Navigate to
https://localhost/mapand/orhttps://localhost/vessel-viewer. Note that if you want to develop/test the progressive web app (offline mode) you'll have to start Chrome with specific flags to omit the SSL self signed certificate error:
Osx
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --user-data-dir=/tmp/foo --ignore-certificate-errors --unsafely-treat-insecure-origin-as-secure=https://localhostWindows
chrome.exe --user-data-dir=/tmp/foo --ignore-certificate-errors --unsafely-treat-insecure-origin-as-secure=https://localhost/Pending: Add https://localhost (or a more meaningful hostname) to the list of redirectUrls in the GFW application
To generate the release notes you can run
nx release changelog [version] -i all -p [project] --from @globalfishingwatchapp/[app]@[prev-tag] --tagVersionPrefix @globalfishingwatchapp/[app] --dry-run.