pieterprovoost / frontend

Hosts GlobalFishingWatch apps and libraries.

This monorepo hosts frontend packages and applications of the GlobalFishingWatch ecosystem.

Packages

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
dataviews-client	Api-client wrapper to fetch and edit dataviews and associated datasets/data
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
fourwings-aggregate	Logic to turn fourwings tiles or cells into meaningful values for the frontend

Applications

fishing-map	Version 3.0 of the fishing map project
vessel-history	Vessel history app
temporalgrid-demo	CRA to show how new custom mapbox-gl format development goes
dataviews-editor	Simple interface to edit dataviews
sandbox	Playground to use packages without releasing

To create a new application using a template with sidebar + map + timebar just run:

nx workspace-generator app [your-name]

nx start [your-name]

Other utils

config	Shared generic build config as tsconfig, rollup or postcss
linting	Define eslint prettier and stylelint configurations

See also

MapLibre GL fork

We maintain our own forks of Mapbox GL to handle gridded temporal data (see temporalgrid branches on both repos)

LayerComposer / Dataviews / Workspaces

See: From WebGL triangles to Dataviews - Organizing visualization of data at GFW

Dependencies

The repo is using yarn workspaces so npm is not suported yet, to install yarn follow this instructions

Install a new dependency

For all packages:

yarn add npm-package -W

Only for a specific package

yarn lerna add npm-package --scope=@scope/my-package

Installation

To install all packages dependencies just run:

yarn

Developmment

Nx 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.

Building

To test all packages builds process run, useful to test everything works well before publishing.

nx build [app-name] --parallel

Publishing

TODO

API DOCS

https://gateway.api.dev.globalfishingwatch.org/swagger#/

Link packages

Go to the package that you want to update RUN: yarn link

Go to the root of the monorepo and run yarn start:packages

Go to your application and run yarn link @globalfishingwatch/{package_folder}

Start your application

Docker Compose

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.

Setup

1. Generate the ssl certificates:

./generate-certificate.sh

2. 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

3. 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

1. Spin up docker compose:

docker-compose up -d

5. Navigate to https://localhost/map and/or https://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://localhost

Windows

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

Generating release notes for github releases

To generate the release notes you can run nx changelog <app_or_lib_name>. This feature makes use of Github REST API to identify Pull Requests labeled with the <app_or_lib_name> label to include them in the changelog What's Changed section. The rest of PRs that are not identified, will be listed in the Other changes not labeled with <app_or_lib_name> section for you to review. It's recommended that you create a Github Personal Access Token and set it to the GH_PAT environment variable so it can be used by this tool to have higher rate limits.