Accessible, simple and fast web client for Mastodon
Go to file
Nolan Lawson cbe7192928 use regular for loop for html dom element collection 2018-04-04 18:34:43 -07:00
assets set up deploy dev/prod scripts 2018-04-04 18:33:08 -07:00
bin fix globalization of css 2018-04-01 02:48:15 -07:00
docs update user guide 2018-04-01 23:22:47 -07:00
fixtures implement requesting to follow someone 2018-03-14 22:32:58 -07:00
original-assets add windows icons, optimize icons 2018-03-22 20:43:16 -07:00
routes use regular for loop for html dom element collection 2018-04-04 18:34:43 -07:00
scss slow loading spinner down a bit 2018-04-03 08:58:59 -07:00
templates slow loading spinner down a bit 2018-04-03 08:58:59 -07:00
tests fix tests 2018-03-31 22:08:24 -07:00
.gitignore set up deploy dev/prod scripts 2018-04-04 18:33:08 -07:00
CONTRIBUTING.md add CONTRIBUTING.md 2018-03-30 17:55:55 -07:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
README.md update readme 2018-04-04 18:33:14 -07:00
package-lock.json clean up dependencies, add deploy script 2018-03-28 18:46:46 -07:00
package.json set up deploy dev/prod scripts 2018-04-04 18:33:08 -07:00
server.js fix service worker caching issues hopefully 2018-03-25 21:31:40 -07:00
webpack.client.config.js tweak webpack config to make it faster and more correct 2018-03-24 18:17:55 -07:00
webpack.server.config.js use standard 2018-02-08 22:29:29 -08:00

README.md

Pinafore

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.

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

This section lays out some high-level goals for Pinafore, as well as the goals it doesn't intend to tackle.

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
  • Ship in the Android/iOS app stores as a Cordova app
  • 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 and contributing

See CONTRIBUTING.md.