Mapsight

Mapsight is a framework for building web applications with OpenLayers and React.

Package overview

Package	Description
⛓️ core | README	Mapsight Core (Redux Store) The core of Mapsight, providing the Redux store and the core architecture (controllers, base actions, redux devtools).
🖥️ ui | README	Default UI (React) The default UI and component library with maps, lists, filters, switchers, etc. Mapsight UI allows you to compose your own UI from the provided components or use a default UI with some configuration and customizations.
🎨 traffic-style | README	Default style package (icons and vector styles) The default style package with icons and vector styles, tailored for traffic applications, but also provides a set of general POI styles and icons, suitable for various use cases.
✏️ vector-style-compiler | README	CSS → OL StyleFunction compiler The vector style compiler is a tool that converts a subset of CSS styles into a multi-layer cached efficient OpenLayers style function, letting you style based on zoom, feature properties, environment, and more. It also allows you to freely add more geometries based on the base features to build complex vector objects.
📦 vite-host-embed | README	Host embed Vite plugin Lib-mode post-build finalize, HTML snippet markers (snippetSources), dev deploy-path aliases, snippet preview.
📦 vite-count-aggregator-embed | README	Count-aggregator CMS Vite plugin App-shell post-build finalize — assets-only deploy tree + paste-ready snippet for @mapsight/count-aggregator-ui.
🌐 lib-ol | README	OpenLayers utilities This package contains utilities for working with OpenLayers.
⚛️ lib-redux | README	Redux utilities This package contains utilities for working with Redux.
⚙️ lib-js | README	JavaScript utilities (Deprecated) This package contains utilities for working with JavaScript. ⚠️ Warning: Do not depend on this package. It is deprecated and will be removed in the future.
📊 count-aggregator-api | README	Count aggregator API client OpenAPI contract, Zod schemas, and typed HTTP client for Mapsight count-aggregator station metadata and aggregated count data.
📈 count-aggregator-ui | README	Count aggregator UI (React) Embeddable wizard, time-series charts, and export links. CMS app-shell embed via vite-count-aggregator-embed.

Applications

Application	Description
🧑‍🎨 vector-editor README	Vector editor for creating and editing vector features exported as GeoJSON.
💡 showcase README	Mapsight ecosystem showcase — UI demo, icon catalog, and runtime icons.

Starters

Copy-out host integration templates. See starters/README.md.

Starter	Status	Description
mapsight-host-starter README	Beta	Host embed build (browserEmbed + paste-ready snippet).
mapsight-next-starter README	WIP	Next.js App Router copy-out template.
mapsight-vite-spa-starter README	WIP	Minimal Vite + React Router SPA copy-out template.

Documentation

See docs/README.md — role-based paths, architecture, integration guides, and getting started.

Development

# Install with pnpm
pnpm install

# Run all tests & checks
pnpm test
pnpm lint
pnpm typecheck
pnpm format:check

# Watch mode
pnpm watch

# Build everything
pnpm build

# Build single package
pnpm --filter @mapsight/vector-style-compiler build

License

The public framework is MIT. See docs/LICENSING.md and docs/TRADEMARK.md for code and brand terms.

For licensing or trademark questions, contact contact@open-mapsight.org. For code, docs, and integration questions, use GitHub issues.

Community

Participation in Mapsight community spaces is governed by our Code of Conduct (Contributor Covenant 3.0).

Security

To report a security vulnerability, see the Open Mapsight security policy or email security@open-mapsight.org.