Alternative web client for Mastodon
Switch branches/tags
Clone or download
nolanlawson fix(dialog): when dialog is hidden, don't scroll to top (#672)
* fix(dialog): when dialog is hidden, don't scroll to top

* update package-lock.json
Latest commit 689dae5 Nov 21, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets add manifest description (#262) May 4, 2018
bin fix(emojos): fix emojos on Ubuntu and Chrome on Windows (#661) Nov 20, 2018
docs simplify theme definitions (#574) Sep 23, 2018
fixtures chore(travis): update to mastodon v2.6.1 (#630) Nov 12, 2018
original-assets add windows icons, optimize icons Mar 23, 2018
routes fix(dialog): when dialog is hidden, don't scroll to top (#672) Nov 21, 2018
scss fix(scroll): prevent horizontal scroll in mobile safari/firefox (#669) Nov 21, 2018
templates fix(scroll): prevent horizontal scroll in mobile safari/firefox (#669) Nov 21, 2018
tests fix(emoji): asterisk should not be treated as emoji (#668) Nov 21, 2018
.gitignore Add CSP (#119) Apr 14, 2018
.travis.yml fix(emojos): fix emojos on Ubuntu and Chrome on Windows (#661) Nov 20, 2018
CONTRIBUTING.md fix(emojos): fix emojos on Ubuntu and Chrome on Windows (#661) Nov 20, 2018
Dockerfile Fixing Dockerfile (#440) Aug 19, 2018
LICENSE add footer and license Mar 7, 2018
README.md Update README.md Aug 25, 2018
inline-script.js simplify theme definitions (#574) Sep 23, 2018
package-lock.json fix(dialog): when dialog is hidden, don't scroll to top (#672) Nov 21, 2018
package.json fix(dialog): when dialog is hidden, don't scroll to top (#672) Nov 21, 2018
server.js fix(server): use compression instead of shrink-ray-current (#629) Nov 11, 2018
webpack.client.config.js perf(terser): remove console logs in production (#658) Nov 18, 2018
webpack.server.config.js use standard Feb 9, 2018

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.