Mirror of upstream Pinafore https://github.com/nolanlawson/pinafore/
Go to file
Matthew Connelly 05a3b2d31f
fix(Dockerfile): Use explicit node version (#2125)
The `node:alpine` Docker image appears to have recently been updated to point to Node 17, breaking new builds of Pinafore. This commit explicitly specifies Node 16 until the underlying reason for the build failure on 17+ can be fixed.
2022-04-19 06:38:06 -07:00
.circleci chore: use node 12 everywhere (#2081) 2021-07-29 07:25:40 -07:00
.husky chore: commit vercel.json, update husky (#1896) 2020-11-23 14:43:39 -08:00
bin fix: add country flag emoji on windows (#2117) 2022-03-27 20:59:02 -07:00
docs chore: update vercel config and docs (#1933) 2021-02-14 14:01:52 -08:00
src fix: make ios status bar default color again (#2123) 2022-04-10 11:25:29 -07:00
static feat: fix ios white status bar + add iOS splash screen (#2108) 2022-04-10 10:34:56 -07:00
tests fix: fix multiple-choice poll results (#2101) 2022-01-02 16:00:41 -08:00
webpack fix!: remove esm package, use native Node ES modules (#2064) 2021-07-04 20:19:04 -07: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 fix!: remove esm package, use native Node ES modules (#2064) 2021-07-04 20:19:04 -07: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 chore: update vercel config and docs (#1933) 2021-02-14 14:01:52 -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 fix: first stab at i18n, extract English strings, add French (#1904) 2020-11-29 14:13:27 -08:00
docker-compose.yml feat: Docker compose (#1767) 2020-05-07 19:45:52 -07:00
package.json 2.1.0 2022-04-15 08:01:00 -07:00
server.js fix!: remove esm package, use native Node ES modules (#2064) 2021-07-04 20:19:04 -07:00
vercel.json fix: add country flag emoji on windows (#2117) 2022-03-27 20:59:02 -07:00
yarn.lock chore(deps): bump moment from 2.29.1 to 2.29.2 (#2119) 2022-04-10 10:36:11 -07:00


Pinafore Build status

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@mastodon.technology.

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 v8+ 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.

In theory you could host these static files yourself (e.g. using nginx or Apache), but it's not recommended, because:

  • You'd have to set the CSP headers yourself, which are an important security feature.
  • Some routes are dynamic and need to be routed to the correct static file.

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.