Something went wrong. Try again.
a tool for shared writing and social publishing forked from leaflet.pub/leaflet
Something went wrong. Try again.
Files
- TypeScript 99%
- CSS <1%
- JavaScript <1%
- Docker <1%
README.md

Leaflet is a tool for shared writing and social publishing.
- **Shared writing**: make Leaflets, instant collaborative docs with rich media, multiple pages and more
- **Social publishing**: create Publications, like blogs or newsletters, that your friends can follow — built on Bluesky
## How to get started
Leaflet is a fast, responsive web app — no installation needed, though you *can* add it as a PWA!
TL;DR below — for more detail and examples, visit the [Leaflet Manual](https://about.leaflet.pub).
### Leaflets
Make a new Leaflet — a simple shareable *post* or *document* — with no account needed at [leaflet.pub/new](https://leaflet.pub/new).
Use Leaflets for shared notes and docs, collections, wikis, homepages and [lots more](https://make.leaflet.pub).
### Publications
To make a Publication, connect with Bluesky from [leaflet.pub/home](https://leaflet.pub/home), then add posts.
Use Publications on Leaflet for blogs, newsletters, project logs — anything you want people to read and follow.
Read ours here: [Leaflet Lab Notes](https://lab.leaflet.pub/).
### Local Development (Linux, WSL)
#### Prerequisites
- [NodeJS](https://nodejs.org/en) (version 20 or later)
- [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started)
- [Docker](https://docker.com) (required for local Supabase)
#### Installation
1. Clone the repository `git clone https://tangled.org/leaflet.pub/leaflet.git`
1. If using WSL, it's recommended to install in the native file structure vs in a mounted Windows file structure (i.e, prefer installing at `~/code/leaflet` vs `/mnt/c/code/leaflet`)
2. Install the dependencies: `npm install`
3. Install the Supabase CLI:
- **macOS:** `brew install supabase/tap/supabase`
- **Windows:** `scoop bucket add supabase https://github.com/supabase/scoop-bucket.git && scoop install supabase`
- **Linux:** Use Homebrew or download packages from [releases pa…