Pinafore’s development branch, with some opinionated themes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
'leftie 6603762a66 fix: typo in sepia theme 4 months ago
bin fix: close/open websocket on freeze/resume events (#1195) 5 months ago
docs chore: switch to yarn (#927) 8 months ago
src fix: typo in sepia theme 4 months ago
static fix: Fix ios design issues (#1199) 5 months ago
tests fix: make autosuggestion accessible (#1183) 5 months ago
webpack fix: close/open websocket on freeze/resume events (#1195) 5 months ago
.dockerignore chore: remove now.json from source control (#1126) 6 months ago
.editorconfig chore(editor): add an editorconfig (#710) 10 months ago
.gitignore chore: remove now.json from source control (#1126) 6 months ago
.nowignore perf: use a separate icons.svg file (#1067) 7 months ago
.travis.yml chore: switch to yarn (#927) 8 months ago
BREAKING_CHANGES.md docs: add documentation about 1.0.0 yarn changes (#959) 8 months ago
CONTRIBUTING.md chore: update to mastodon v2.8.2 (#1181) 5 months ago
Dockerfile Clean yarn cache during docker image build phase (#1073) 7 months ago
LICENSE add footer and license 1 year ago
README.md perf: reduce install size using yarn --production (#1066) 7 months ago
package.json 1.7.0 5 months ago
server.js fix: use static server for `node server.js` (#1041) 7 months ago
webpack.config.js fix: update Sapper to latest (#775) 10 months ago
yarn.lock chore: update deps (#1206) 5 months ago

README.md

Pinafore Build Status Greenkeeper badge

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

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

Secondary / possible future goals

  • Support for Pleroma or other non-Mastodon backends
  • Serve as an alternative frontend tied to a particular instance
  • Support for non-English languages (i18n)
  • Offline search

Non-goals

  • 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)

Building

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

Docker

To build a Docker image for production:

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

Now Pinafore is running at localhost:4002.

Updating

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)

Exporting

You can export Pinafore as a static site. Run:

yarn run export

Static files will be written to __sapper__/export.

Note that this is not the recommended method, because CSP headers are not currently supported for the exported version.

Developing and testing

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

Changelog

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.