An alternative web client for Mastodon, focused on speed and simplicity.
 
 
 
Go to file
Nolan Lawson 537ad208a3
chore(editor): add an editorconfig (#710)
2018-12-01 23:06:34 -08:00
assets
bin fix(a11y): fix NVDA crash on long aria-label (#702) 2018-12-01 00:10:30 -08:00
docs
fixtures
original-assets
routes feat(ui): add option to always show sensitive media (#709) 2018-12-01 14:09:08 -08:00
scss
templates
tests feat(ui): add option to always show sensitive media (#709) 2018-12-01 14:09:08 -08:00
.editorconfig chore(editor): add an editorconfig (#710) 2018-12-01 23:06:34 -08:00
.gitignore
.travis.yml
CONTRIBUTING.md
Dockerfile
LICENSE
README.md
inline-script.js
package-lock.json chore(package): update to webpack 4.26.1 (#703) 2018-12-01 00:00:11 -08:00
package.json chore(package): update to webpack 4.26.1 (#703) 2018-12-01 00:00:11 -08:00
server.js
webpack.client.config.js
webpack.server.config.js

README.md

Pinafore Build Status Greenkeeper badge

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

Pinafore is available at pinafore.social. Bleeding-edge releases are at dev.pinafore.social.

See the user guide for basic usage. See the admin guide to troubleshoot instance compatibility issues.

For updates and support, follow us at @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
  • Fast even on low-end phones
  • Works offline in read-only mode
  • Progressive Web App features
  • Multi-instance support
  • Support latest versions of Chrome, Edge, Firefox, and Safari
  • a11y (keyboard navigation, screen readers)

Possible future goals

  • Works as an alternative frontend self-hosted by instances
  • Android/iOS apps (using Cordova or similar)
  • Support Pleroma/non-Mastodon backends
  • i18n
  • Offline search
  • Full emoji keyboard
  • Keyboard shortcuts

Non-goals

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

Building

Pinafore requires Node.js v8+ and npm.

To build Pinafore for production:

npm install
npm run build
PORT=4002 npm start

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)

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.