100,000s of maps are available through IIIF, across libraries, archives and museums worldwide. Allmaps makes it easier and more inspiring to curate, georeference and explore collections of digitized maps.
π For more information about the Allmaps project, see allmaps.org.
Allmaps is an open source project and consists of multiple apps and packages, all written in TypeScript and contained by this monorepo.
Apps:
Packages:
- @allmaps/annotation
- @allmaps/id
- @allmaps/iiif-parser
- @allmaps/leaflet
- @allmaps/maplibre
- @allmaps/openlayers
- @allmaps/render
- @allmaps/schemas
- @allmaps/stdlib
- @allmaps/tailwind
- @allmaps/transform
- @allmaps/triangulate
- @allmaps/types
- @allmaps/ui
To see how these apps and packages are related, check out the dependency graph.
Make sure you have Node.js (version 20.8 or higher) and pnpm installed.
You can install pnpm with Corepack:
corepack enable
corepack prepare pnpm@latest --activate
Then, clone this repository locally:
git clone https://github.com/allmaps/allmaps.git
cd allmaps
Install dependencies and create symlinks:
pnpm install -r
Finally, build all packages to ensure all JavaScript exports are created from TypeScript files, and initialize SvelteKit apps:
pnpm run init
To run the dev
script for a single app, you need to run the watch
scripts of all packages in one terminal window:
pnpm run watch
And then run the dev
script of the app in another:
pnpm --filter "@allmaps/viewer" run dev
You can also run the dev
script from the app's directory instead:
cd apps/viewer
pnpm run dev
To run the watch
and dev
scripts for all packages and apps, run the following in one terminal window:
pnpm run watch
And this in another:
pnpm run dev
If things don't work, it might help to reinitialize the SvelteKit apps:
pnpm run check
Or, reinstall dependencies and create the monorepo's symlinks:
pnpm install -r
As a last resort, you can try to remove some (or all) node_modules
directories using npkill:
pnpm dlx npkill
This repository uses Husky to run type checking, code linting and tests before each commit.
To skip these tests, you can use git's --no-verify
option:
git commit --no-verify
Check TypeScript types for all packages:
pnpm run types
Run Prettier and ESLint for all packages:
pnpm run lint
Run tests for all packages and apps:
pnpm run test
Run tests for a single package:
pnpm --filter "@allmaps/transform" test
You can run the tests from the package's directory instead:
cd packages/transform
pnpm test
Create prerelease versions:
lerna version prerelease
Publish beta versions to npm:
lerna publish from-git --dist-tag beta
Promoting unchanged pre-release versions:
lerna version --conventional-commits --conventional-graduate