SkopeUI is the Nuxt 4 frontend for the Synthesizing Knowledge of Past Environments platform. It provides dataset discovery, interactive MapLibre visualization, study-area selection, and time-series analysis backed by skope-api.
Install Git, GNU Make 4.3 or newer, Docker, and Docker Compose on the host. Node and npm commands run inside the application container. Runtime and package-manager versions are defined in the Dockerfile and package.json; dependencies are installed reproducibly with npm ci from app/package-lock.json.
Start the development server at http://localhost:3000:
make deploy-devThe development build uses http://localhost:8001 for the API by default. Override it for a single command when needed:
make deploy-dev SKOPE_API_HOST_URL=http://example.test:8001Run the test suite with make test. Use make lint to run ESLint with automatic fixes, or make format to format files and apply ESLint fixes; both commands can modify source files.
After pulling dependency changes, recreate the development container and its anonymous /code/node_modules volume so it uses the rebuilt image's dependencies:
make down ENVIRONMENT=dev
make deploy-devInclude your SKOPE_API_HOST_URL override again if you use a custom API endpoint.
Each deployment target selects its API endpoint explicitly:
| Target | UI image | API endpoint |
|---|---|---|
make deploy-dev |
openskope/skopeui:dev |
http://localhost:8001 |
make deploy-staging |
openskope/skopeui:staging |
https://staging-api.openskope.org |
make deploy-production |
openskope/skopeui:prod |
https://api.openskope.org |
Deployments build the selected image, replace the running Compose service, and wait for its health check. Use make config ENVIRONMENT=staging to inspect the resolved Compose configuration before deploying. Operational commands accept the same environment selection, for example:
make ps ENVIRONMENT=staging
make logs ENVIRONMENT=staging
make restart ENVIRONMENT=staging
make down ENVIRONMENT=stagingThe API URL is compiled into the Nuxt client bundle. Rebuild the image after changing SKOPE_API_HOST_URL.
The GitHub Actions workflow runs the test suite and builds the production image for pushes and pull requests against main. It does not check the staging API URL; run make build ENVIRONMENT=staging locally before merging an upgrade.
The Docker build follows the active Node LTS image and enforces the supported engine ranges in app/package.json. When LTS moves outside those ranges, CI fails until the new runtime and dependencies are reviewed. Rebuild regularly to receive base-image updates. Production contains only the Node runtime, required system packages, and Nuxt's built output; npm is available in the development image.
When changing dependencies, regenerate app/package-lock.json in Docker, rebuild the image, and recreate the development container as described above. Check compatibility with the framework and build tools, and select stable releases explicitly: a package's latest tag can point to a prerelease. Keep exact versions in the Dockerfile, package manifest, and lockfile rather than duplicating them in documentation.
Audit the lockfile's installed dependencies in a freshly built development image:
make build ENVIRONMENT=dev
docker run --rm openskope/skopeui:dev npm auditCompare resolved versions, including nested copies, with the repository's Dependabot alerts. Alerts describe the default branch and can remain open until an upgrade is merged. Review dependency overrides with each upgrade and remove them when upstream dependencies provide the required fixes. npm can report several affected parent packages for one advisory; inspect the dependency chain before accepting a suggested downgrade.
Validate upgrades with make test and make build ENVIRONMENT=staging. In a browser, also check dataset loading, study-area drawing and editing, raster playback, time-series plotting, and exports; automated tests and builds do not exercise the full interactive workflow.
- Manuela Vanegas Ferro @manuvanegas
- Allen Lee @alee
- Kyle Bocinsky @bocinsky
Past and present contributions are recorded in the GitHub contributors history.