sample.env

# Save a copy of this file as .env in this directory, and then update that.
# DO NOT MODIFY sample.env IN PLACE, as it will be ignored.

# This file will be used for local development.
# See also sample.env in the dist directory
# (for specifying where to deploy the script, and the configuration values there).

# The Strava details can be accessed at https://www.strava.com/settings/api
# Note that these do not have to be the same between local development and the deployed server,
# as a different Strava account can be used for each.
STRAVA_CLIENT_ID=
STRAVA_CLIENT_SECRET=

# MAPBOX_TOKEN is the token for using Mapbox.
MAPBOX_TOKEN=

# MAPBOX_STYLE is the default style to use. This can be one of:
# - natural
# - NATURAL_LIGHT
# - NATURAL_DARK
# - ORIGINAL
# - minimal
# - MINIMAL_LIGHT
# - MINIMAL_DARK
# - STANDARD
# - OUTDOOR
# - SATELLITE
# - HYBRID
MAPBOX_STYLE=minimal

# USE_STRAVA_ICONS: set to true to use Strava icons for activity types
USE_STRAVA_ICONS=false

# VALIDATE_USER_BEFORE_CACHE: set to true to check with the backend that the user exists before showing data
VALIDATE_USER_BEFORE_CACHE=false

# The name of the app, as used in the HTML title and logo
VITE_APP_NAME="Heatmapper"

# The favicon for this deployment, as an absolute path from the site root, e.g. /favicon-h.svg.
# Leave blank to keep the default Vue logo.
VITE_APP_FAVICON=

# A list of device brands to show attribution for, separated by commas.
# For example:
#   ATTRIBUTION="Garmin, Suunto, Polar"
# To show all attributions, use a single asterisk:
#   ATTRIBUTION="*"
ATTRIBUTION="*"

# These are the ports on localhost to run the development servers on.
# Note that the frontend server will proxy any API requests to the backend server, which must also
# be running, either locally or remotely (by specifying SERVER_PORT or SERVER_DOMAIN).
# If a domain is provided, it should contain everything before the first slash of the path,
# including the port (unless it is accessible through the default port, i.e. 80 for http or
# 443 for https), e.g. one of:
#   SERVER_DOMAIN=https://heatmapper.charding.dev
#   SERVER_DOMAIN=http://192.168.1.2:345
#
# Alternatively, the backend development server can be accessed directly, and this will serve the
# latest production build of the frontend server (i.e. by running `yarn build` or `./build`).
#
# Note that, if no SERVER_DOMAIN is provided, it will only be possible to log on from a browser on
# the computer that is hosting the development server. If a SERVER_DOMAIN is provided, it must
# match the callback domain specified at https://www.strava.com/settings/api
VITE_DEV_PORT=8081
SERVER_PORT=8080
SERVER_DOMAIN=

# These configure the mock of Strava that "yarn dev --mock" runs in the backend (MOCK_STRAVA=true).
# It serves one activity a day, back to MOCK_OLDEST_ACTIVITY (an ISO date, or a year ago when
# blank), cycling through MOCK_ACTIVITY_TYPES, with ten routes for each of those that can be a
# route. Each page of activities or routes takes MOCK_PAGE_DELAY_MS, and anything else MOCK_DELAY_MS.
# Blank means the defaults: Ride,Run,Walk, 10000 and 500.
# MOCK_NOW pins its present to an ISO time no later than now, or follows the clock when blank.
# STRAVA_BASE_URL points the backend at another Strava, real or mock, in place of www.strava.com.
MOCK_OLDEST_ACTIVITY=
MOCK_NOW=
MOCK_ACTIVITY_TYPES=
MOCK_PAGE_DELAY_MS=
MOCK_DELAY_MS=