Skip to content

developmentseed/gfts

Repository files navigation

Global Fish Tracking System

Installation and Usage

The steps below will walk you through setting up your own instance of the project.

Install Project Dependencies

To set up the development environment for this website, you'll need to install the following on your system:

  • Node v24 (To manage multiple node versions we recommend nvm)
  • Yarn Package manager

Install Application Dependencies

If you use nvm, activate the desired Node version:

nvm install

Install Node modules:

yarn install

Initialize the Submodules

The destine data repo is at: https://github.com/developmentseed/gfts-detine-data
If you cloned the repository with git clone --recursive, you can skip this step. Otherwise, run:

git submodule update --init --recursive

How the submodules are used

The submodule is a private repository that is used to include the Destine data which cannot be publicly shared.

When the app is built, the submodule is copied to the destine folder in the dist directory. The server will then handle requests to the destine folder and block the however is not authenticated. Therefore, even though the data looks like it is freely available, it is actually protected by the server.

Usage

Config files

Configuration is done using dot.env files.

These files are used to simplify the configuration of the app and should not contain sensitive information.

Run the project locally by copying the .env to .env.local and setting the following environment variables:

VAR Description
MAPBOX_TOKEN Mapbox token for the map

Starting the app

yarn serve

Compiles the sass files, javascript, and launches the server making the site available at http://localhost:9000/ The system will watch files and execute tasks whenever one of them changes. The site will automatically refresh since it is bundled with livereload.

Map style

The map style being used is in the Devseed account. Update it through mapbox studio and publish to change it.

About

Global Fish Tracing System exploration app

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5