tomtom-maps-sdk-js
tomtom-international/maps-sdk-js · skills.sh
Open source Repository Open in the app JSON README (API)
About
Skill publicada por tomtom-international/maps-sdk-js no skills.sh. Instale com: npx skills add tomtom-international/maps-sdk-js@tomtom-maps-sdk-js
Details
- Kind
- Agent skills
- Topic
- Developer tools
- Publisher
- tomtom-international
- Origin
- skillssh
- Category
- ferramentas
- Stars
- 35
- Forks
- 5
- Last push
- 2026-10-06T15:22:13Z
- Repository state
- ativo
- Language
- TypeScript
- License
- NOASSERTION
- Added
- 2026-10-07 05:31:22
- Updated
- 2026-10-07 05:31:22
- Origin id
tomtom-international/maps-sdk-js/tomtom-maps-sdk-js
README
# TomTom Maps SDK for JavaScript — Examples [🎮 **Examples**](https://docs.tomtom.com/maps-sdk-js/examples/) | [📖 **Documentation**](https://docs.tomtom.com/maps-sdk-js/introduction/overview) | [📋 **API Reference**](https://docs.tomtom.com/maps-sdk-js/api-reference/index.html) | [📦 **npm**](https://www.npmjs.com/package/@tomtom-org/maps-sdk)  The runnable examples of the [TomTom Maps SDK for JavaScript](https://docs.tomtom.com/maps-sdk-js/introduction/overview) (`@tomtom-org/maps-sdk`) and its plugins: over 110 browser apps and Node.js scripts, the best code to copy from. The SDK itself installs from npm; its sources are not published in this repository. Each example installs the SDK and plugins at the versions they were last synced against, pinned in the `catalog` of [`pnpm-workspace.yaml`](https://github.com/tomtom-international/maps-sdk-js/blob/HEAD/pnpm-workspace.yaml). <br/><br/> ## 🚀 Running an example **Requirements**: Node.js 24+, pnpm 11+ (`corepack enable`), and a [TomTom API key](https://my.tomtom.com/). ```bash pnpm install cp examples/.env.example examples/.env # then set API_KEY_EXAMPLES cd examples/default-map pnpm develop # a Vite dev server, on http://localhost:5173 ``` A Node.js example reads the key from the environment: ```bash cd examples/nodejs-geocode API_KEY_EXAMPLES=<your key> pnpm develop ``` A few examples need more than the one key; [`examples/.env.example`](https://github.com/tomtom-international/maps-sdk-js/blob/HEAD/examples/.env.example) lists each extra. Every example only imports `@tomtom-org/maps-sdk/*` and `@tomtom-org/maps-sdk-plugin-*`, as your own app would: copy its `src/` into a project that installs those packages. <br/><br/> ## 🤖 AI Coding Agent Skill Install the SDK skill for AI coding agents (Claude Code, Cursor, GitHub Copilot, Windsurf, and [many more](https://www.npmjs.com/package/skills#available-agents)) to get SDK-specific assistance in your coding agent: ```bash npx skills add tomtom-international/maps-sdk-js --skill tomtom-maps-sdk-js ``` [AI coding with the SDK](https://docs.tomtom.com/maps-sdk-js/guides/ai-coding) lists the topics it covers and how to invoke them. <br/><br/> ## 📋 Changelogs - [`CHANGELOG.md`](https://github.com/tomtom-international/maps-sdk-js/blob/HEAD/CHANGELOG.md) — the SDK (`@tomtom-org/maps-sdk`) - `plugins/<name>/CHANGELOG.md` — each plugin, next to its `README.md` The [Release Notes](https://docs.tomtom.com/maps-sdk-js/introduction/release-notes) cover what's new and the breaking changes. <br/><br/> ## 💬 Feedback This repository is a read-only mirror of an internal one, so it does not accept pull requests. [Open an issue](https://github.com/tomtom-international/maps-sdk-js/issues) to report a bug, or [start a discussion](https://github.com/tomtom-international/maps-sdk-js/discussions) for questions and feature requests. <br/><br/> ## 📄 License - **Examples** — all code in `examples/` is open-source under the Apache V2.0 License: 📜 [examples/LICENSE](https://github.com/tomtom-international/maps-sdk-js/blob/HEAD/examples/LICENSE). Copy, modify and use it freely in your projects. - **SDK packages and plugins** — `@tomtom-org/maps-sdk` and `@tomtom-org/maps-sdk-plugin-*`, which the examples install, are distributed under a proprietary license: 📜 [LICENSE.txt](https://github.com/tomtom-international/maps-sdk-js/blob/HEAD/LICENSE.txt), copied as each plugin's `plugins/<name>/LICENSE.txt`. They require a TomTom API key and agreement to our terms of service. Their third-party notices are in [THIRD_PARTY.txt](https://github.com/tomtom-international/maps-sdk-js/blob/HEAD/THIRD_PARTY.txt).