Mirror of upstream Pinafore https://github.com/nolanlawson/pinafore/
Go to file
Nolan Lawson f61054a3d5
test: add test for #2263 (#2317)
2022-12-11 12:46:59 -08:00
.github/workflows test: run tests on Mastodon v4 (#2256) 2022-12-02 15:09:58 -08:00
.husky chore: commit vercel.json, update husky (#1896) 2020-11-23 14:43:39 -08:00
bin fix: back button icon rendering inconsistently (#2306) 2022-12-10 23:30:43 +00:00
docs docs: add details on use of Svelte v2 / Sapper 2022-11-21 07:42:30 -08:00
src fix: show proper notification text for follow request (#2314) 2022-12-11 12:01:01 -08:00
static chore: use node 14 in CI, update mocha, fix gitignore (#2191) 2022-11-17 17:09:37 -08:00
tests test: add test for #2263 (#2317) 2022-12-11 12:46:59 -08:00
webpack chore: remove emoji picker i18n files (#2258) 2022-11-25 12:06:09 -08:00
.dockerignore fix: internationalize manifest.json (#2034) 2021-04-11 19:40:24 -07:00
.editorconfig chore(editor): add an editorconfig (#710) 2018-12-01 23:06:34 -08:00
.gitignore chore: use node 14 in CI, update mocha, fix gitignore (#2191) 2022-11-17 17:09:37 -08:00
.testcaferc.json test: improve testcafe test flakiness, use config file (#1627) 2019-11-09 17:25:33 -05:00
.vercelignore fix: internationalize manifest.json (#2034) 2021-04-11 19:40:24 -07:00
BREAKING_CHANGES.md 2.0.0 2021-08-06 12:00:18 -07:00
CHANGELOG.md 2.0.0 2021-08-06 12:00:18 -07:00
CONTRIBUTING.md docs: update mastodon dev guide link (#2272) 2022-12-02 11:14:32 -08:00
Dockerfile fix(Dockerfile): Use explicit node version (#2125) 2022-04-19 06:38:06 -07:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
README.md chore: switch from circle ci to github actions (#2253) 2022-11-25 11:04:37 -08:00
docker-compose.yml feat: Docker compose (#1767) 2020-05-07 19:45:52 -07:00
package.json 2.4.0 2022-11-27 17:38:00 -08:00
server.js fix!: remove esm package, use native Node ES modules (#2064) 2021-07-04 20:19:04 -07:00
vercel.json fix: reduce flash-of-unstyled on grayscale (#2206) 2022-11-19 11:25:42 -08:00
yarn.lock chore(deps): bump decode-uri-component from 0.2.0 to 0.2.2 (#2289) 2022-12-03 16:35:55 -08:00



An alternative web client for Mastodon, focused on speed and simplicity.

Pinafore is available at pinafore.social. Beta releases are at dev.pinafore.social.

See the user guide for basic usage. See the admin guide if Pinafore cannot connect to your instance.

For updates and support, follow @pinafore@fosstodon.org.

Browser support

Pinafore supports the latest versions of the following browsers:

  • Chrome
  • Edge
  • Firefox
  • Safari

Compatible versions of each (Opera, Brave, Samsung, etc.) should be fine.

Goals and non-goals


  • Support the most common use cases
  • Small page weight
  • Fast even on low-end devices
  • Accessibility
  • Offline support in read-only mode
  • Progressive Web App features
  • Multi-instance support
  • Support latest versions of Chrome, Edge, Firefox, and Safari
  • Support non-Mastodon instances (e.g. Pleroma) as well as possible
  • Internationalization

Secondary / possible future goals

  • Serve as an alternative frontend tied to a particular instance
  • Offline search


  • Supporting old browsers, proxy browsers, or text-based browsers
  • React Native / NativeScript / hybrid-native version
  • Android/iOS apps (using Cordova or similar)
  • Full functionality with JavaScript disabled
  • Emoji support beyond the built-in system emoji
  • Multi-column support
  • Admin/moderation panel
  • Offline support in read-write mode (would require sophisticated sync logic)


Pinafore requires Node.js and Yarn.

To build Pinafore for production, first install dependencies:

yarn --production --pure-lockfile

Then build:

yarn build

Then run:

PORT=4002 node server.js


To build a Docker image for production:

docker build .
docker run -d -p 4002:4002 [your-image]

Now Pinafore is running at localhost:4002.


Alternatively, use docker-compose to build and serve the image for production:

docker-compose up --build -d

The image will build and start, then detach from the terminal running at localhost:4002.


To keep your version of Pinafore up to date, you can use git to check out the latest tag:

git checkout $(git tag -l | sort -Vr | head -n 1)


Pinafore is a static site. When you run yarn build, static files will be written to __sapper__/export.

It is not recommended to directly expose these files when self-hosting. Instead, you should use node server.js (e.g. with an nginx or Apache proxy in front). This adds several things you don't get from the raw static files:

  • CSP headers (important for security)
  • Certain dynamic routes (less important because of Service Worker managing routing, but certain things could break if Service Workers are disabled in the user's browser)

Having an nginx config generator is currently an open issue.

Developing and testing

See CONTRIBUTING.md for how to run Pinafore in dev mode and run tests.


For a changelog, see the GitHub releases.

For a list of breaking changes, see BREAKING_CHANGES.md.

What's with the name?

Pinafore is named after the Gilbert and Sullivan play. The soundtrack is very good.