Mirror of nolanlawson/pinafore
Go to file
Nolan Lawson 46b44feb35
chore: update svelte-loader (#1582)
2019-10-15 17:27:36 -07:00
bin fix: do not cache license files in service worker (#1575) 2019-10-15 06:52:27 -07:00
docs chore: switch to yarn (#927) 2019-01-27 17:44:30 -08:00
src fix: use short usernames in options dialog (#1576) 2019-10-15 07:56:39 -07:00
static feat: add KaiOS manifest file (#1528) 2019-09-24 00:50:42 -07:00
tests feat: add hashtag autocomplete (#1567) 2019-10-12 18:06:04 -07:00
webpack perf: use webpack contenthash for better caching (#1573) 2019-10-14 20:00:57 -07:00
.dockerignore chore: remove now.json from source control (#1126) 2019-03-31 10:55:54 -07:00
.editorconfig chore(editor): add an editorconfig (#710) 2018-12-01 23:06:34 -08:00
.gitignore chore: remove now.json from source control (#1126) 2019-03-31 10:55:54 -07:00
.nowignore perf: use a separate icons.svg file (#1067) 2019-03-02 19:02:06 -08:00
.travis.yml chore: delete posix-spawn-benchmark in travis (#1561) 2019-10-08 17:47:40 -07:00
BREAKING_CHANGES.md docs: add documentation about 1.0.0 yarn changes (#959) 2019-02-10 11:30:00 -08:00
CONTRIBUTING.md feat: add debug build (#1506) 2019-09-21 13:44:32 -07:00
Dockerfile Clean yarn cache during docker image build phase (#1073) 2019-03-03 13:25:42 -08:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
README.md docs: update docs on exporting (#1290) 2019-06-22 11:32:17 -07:00
package.json chore: update svelte-loader (#1582) 2019-10-15 17:27:36 -07:00
server.js chore: update standard to v13 (#1370) 2019-08-03 13:49:37 -07:00
webpack.config.js fix: update Sapper to latest (#775) 2018-12-11 07:31:48 -08:00
yarn.lock chore: update svelte-loader (#1582) 2019-10-15 17:27:36 -07:00

README.md

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

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

To build Pinafore for production, first install dependencies:

yarn --production --pure-lockfile

Then build:

yarn build

Then run:

PORT=4002 node server.js

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

Pinafore is a static site. When you run yarn build, static files will be written to __sapper__/export.

In theory you could host these static files yourself (e.g. using nginx or Apache), but it's not recommended, because:

  • You'd have to set the CSP headers yourself, which are an important security feature.
  • Some routes are dynamic and need to be routed to the correct static file.

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.

For a list of breaking changes, see BREAKING_CHANGES.md.

What's with the name?

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