stac-map

The map-first, single-page, statically-hosted STAC visualizer at https://developmentseed.org/stac-map.

Includes:

• Natural language collection search
• stac-geoparquet visualization, upload, and download

Warning

This application is in its infancy 👶 and will change significantly and/or break at any time.

Development

Get yarn, then:

git clone git@github.com:developmentseed/stac-map
cd stac-map
yarn install
yarn dev

This will open a development server at http://localhost:5173/stac-map/.

We have some code quality checks/tools:

yarn lint
yarn format

And some simple tests:

yarn playwright install
yarn test

Contributing

We have some architecture documentation to help you get the lay of the land. We use Github Pull Requests to propose changes, and Issues to report bugs and request features.

We use semantic-release to create releases. This requires our commit messages to conform to Conventional Commits.

Deploying

See deploy.yaml for a (drop-dead simple) example of deploying this application as a static site via Github Pages.

White-label deployment

You can deploy your own customized version of stac-map using environment variables:

Variable	Description	Default
VITE_BASE_PATH	URL path prefix (e.g., /my-app/)	/stac-map/
VITE_DEFAULT_HREF	STAC resource to load on startup	None (shows intro)

Example:

VITE_BASE_PATH=/ VITE_DEFAULT_HREF=https://my-stac-api.com yarn build

Or create a .env file:

VITE_BASE_PATH=/
VITE_DEFAULT_HREF=https://my-stac-api.com

Then run yarn build and deploy the dist/ directory to your static hosting provider. For an example of white-labeling stac-map, see https://github.com/gadomski/eoapi.stac-map.io.

Versioning

For now, we use a form of Sentimental Versioning, where we use MAJOR, MINOR, and PATCH versions to communicate the "weight" of changes. We may formalize our releases into a stricter form of Semantic Versioning at some point in the future.