Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Atlasdraw workspace

This folder is the Atlasdraw code: a Yarn 4 workspace with three apps and eleven packages. What the product is and how to host it are in the repository README.

Layout

  • apps/atlas-app/ — the editor, the read-only viewer (/m) and the embed (/embed).
  • apps/storage/ — the HTTP API for saved maps, write keys and share links.
  • apps/realtime/ — the relay for live rooms.
  • packages/geo/, packages/basemap/, packages/tools/, packages/data/, packages/protocol/, packages/cli/ — the Atlasdraw packages.
  • packages/excalidraw/, packages/element/, packages/math/, packages/common/, packages/utils/ — the Excalidraw fork. Atlasdraw owns it; nothing syncs from upstream (decisions/0010-own-the-fork.md).
  • bench/ — parse timings for packages/data, and an A/B gate that CI runs as a report only.
  • decisions/ — ADR 0001–0010 and the early research notes.

Quick start

corepack enable      # gives the yarn version that package.json pins
yarn install
yarn start           # the editor on http://localhost:5174

Before you commit, run yarn test:typecheck and yarn test --watch=false. CLAUDE.md lists the other commands.

Licence

Each package has its own licence. The apps are AGPL-3.0-only; cli, geo, data and protocol are MIT; basemap and tools are MPL-2.0. The table and the reasons are in LICENSING.md.

Credits

The drawing engine is a fork of Excalidraw; its licence is in LICENSE-EXCALIDRAW-UPSTREAM. The map is MapLibre GL, and the bundled basemap uses the Protomaps format.