Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.48 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.48 KB
Raw

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 v20 (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

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.