Mirror of upstream Pinafore https://github.com/nolanlawson/pinafore/
Go to file
Nolan Lawson 270df188cb
Store IDB data for 1 week rather than 2 weeks (#498)
Based on issues I'm seeing on iOS Safari, I'm guessing that my IDB caching is too aggressive and is hitting origin storage limits, which causes IDB transactions in safari to fail silently and never call any transaction callbacks (`onblocked`, `onerror`, `oncomplete`).

This is pretty bad and causes Pinafore to basically just not work unless you clear site data, which we should avoid. 2 weeks was probably unnecessary anyway; in a social network, who cares about content that's 2 weeks old?
2018-08-26 15:38:54 -07:00
assets add manifest description (#262) 2018-05-03 21:24:18 -07:00
bin update Mastodon used in tests to v2.4.3 (#447) 2018-08-19 14:46:48 -07:00
docs Add instructions for admins to achieve Pinafore compatibility (#406) 2018-07-02 10:33:44 -07:00
fixtures update Mastodon used in tests to v2.4.3 (#447) 2018-08-19 14:46:48 -07:00
original-assets add windows icons, optimize icons 2018-03-22 20:43:16 -07:00
routes Store IDB data for 1 week rather than 2 weeks (#498) 2018-08-26 15:38:54 -07:00
scss remove will-change:transform from container (#470) 2018-08-22 19:26:13 -07:00
templates add null check for index.html fetch in SW (#484) 2018-08-24 08:51:09 -07:00
tests add application (client) name to statuses (#497) 2018-08-26 15:38:45 -07:00
.gitignore Add CSP (#119) 2018-04-14 15:50:16 -07:00
.travis.yml tests: use npm ci || npm i in travis (#373) 2018-06-08 09:27:00 -07:00
CONTRIBUTING.md update to mastodon 2.4.0 in travis (#371) 2018-06-07 15:26:47 -07:00
Dockerfile Fixing Dockerfile (#440) 2018-08-18 21:20:33 -07:00
inline-script.js remove link rel=manifest for iOS (#443) 2018-08-18 23:14:30 -07:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
package-lock.json 0.7.0 2018-08-25 12:54:04 -07:00
package.json 0.7.0 2018-08-25 12:54:04 -07:00
README.md Update README.md 2018-08-25 13:04:41 -07:00
server.js remove link rel=manifest for iOS (#443) 2018-08-18 23:14:30 -07:00
webpack.client.config.js isolate autosuggestion state (#273) 2018-05-06 16:25:17 -07:00
webpack.server.config.js use standard 2018-02-08 22:29:29 -08:00

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.