Mirror of upstream Pinafore https://github.com/nolanlawson/pinafore/
Go to file
Nolan Lawson 32981ffeb2
Update README.md
[skip ci]
2018-12-18 20:50:30 -08:00
bin fix: use emoji-mart all.json, split out json (#839) 2018-12-18 12:45:49 -08:00
docs fix: update Sapper to latest (#775) 2018-12-11 07:31:48 -08:00
fixtures chore(travis): update to mastodon v2.6.1 (#630) 2018-11-12 12:59:47 -08:00
original-static fix: update Sapper to latest (#775) 2018-12-11 07:31:48 -08:00
scss chore: make build process faster/simpler (#833) 2018-12-17 17:21:29 -08:00
src fix(picker): only focus picker search on desktop (#843) 2018-12-18 20:01:53 -08:00
src-build chore: make build process faster/simpler (#833) 2018-12-17 17:21:29 -08:00
static chore(git): remove ignored files from git (#801) 2018-12-13 21:32:32 -08:00
tests feat: add full emoji picker using emoji-mart (#836) 2018-12-18 00:43:51 -08:00
thirdparty/font-awesome-svg-png fix: remove font-awesome-svg-png (#810) 2018-12-15 17:13:27 -08:00
webpack feat: add full emoji picker using emoji-mart (#836) 2018-12-18 00:43:51 -08:00
.editorconfig chore(editor): add an editorconfig (#710) 2018-12-01 23:06:34 -08:00
.gitignore fix: use emoji-mart all.json, split out json (#839) 2018-12-18 12:45:49 -08:00
.travis.yml chore: upgrade travis/now to node v10 (#834) 2018-12-17 17:30:12 -08:00
CONTRIBUTING.md chore: make build process faster/simpler (#833) 2018-12-17 17:21:29 -08:00
Dockerfile Fixing Dockerfile (#440) 2018-08-18 21:20:33 -07:00
inline-script.js fix: fix logging in and out with a refresh (#824) 2018-12-16 12:39:16 -08:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
package-lock.json perf: reduce size of emoji-mart dep using fork (#841) 2018-12-18 14:40:14 -08:00
package.json perf: reduce size of emoji-mart dep using fork (#841) 2018-12-18 14:40:14 -08:00
README.md Update README.md 2018-12-18 20:50:30 -08:00
webpack.config.js fix: update Sapper to latest (#775) 2018-12-11 07:31:48 -08:00

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
  • Keyboard shortcuts

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

Exporting

You can export Pinafore as a static site. Run:

npm 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.

What's with the name?

Pinafore is named after the Gilbert and Sullivan play. The soundtrack is very good.