You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
forest 0616a2bafa clean up docker build now that i'm not debugging the cleaner any more 11 months ago
.circleci chore: use node 12 everywhere (#2081) 1 year ago
.husky chore: commit vercel.json, update husky (#1896) 2 years ago
bin optimize the docker build 11 months ago
docs chore: update vercel config and docs (#1933) 2 years ago
src fix: fix multiple-choice poll results (#2101) 11 months ago
static fix: internationalize manifest.json (#2034) 2 years ago
tests fix: fix multiple-choice poll results (#2101) 11 months ago
webpack fix!: remove esm package, use native Node ES modules (#2064) 1 year ago
.dockerignore fix: internationalize manifest.json (#2034) 2 years ago
.editorconfig chore(editor): add an editorconfig (#710) 4 years ago
.gitignore optimize the docker build 11 months ago
.testcaferc.json test: improve testcafe test flakiness, use config file (#1627) 3 years ago
.vercelignore fix: internationalize manifest.json (#2034) 2 years ago
BREAKING_CHANGES.md 2.0.0 1 year ago
CHANGELOG.md 2.0.0 1 year ago
CONTRIBUTING.md chore: update vercel config and docs (#1933) 2 years ago
Dockerfile clean up docker build now that i'm not debugging the cleaner any more 11 months ago
LICENSE add footer and license 5 years ago
README.md fix: first stab at i18n, extract English strings, add French (#1904) 2 years ago
build-docker.sh optimize the docker build 11 months ago
docker-compose.yml feat: Docker compose (#1767) 3 years ago
package.json optimize the docker build 11 months ago
server.js optimize the docker build 11 months ago
vercel.json chore: update deps (#2052) 2 years ago
yarn.lock chore(deps): bump nth-check from 2.0.0 to 2.0.1 (#2091) 1 year ago

README.md

Pinafore Build status

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
  • Support non-Mastodon instances (e.g. Pleroma) as well as possible
  • Internationalization

Secondary / possible future goals

  • Serve as an alternative frontend tied to a particular instance
  • 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.

docker-compose

Alternatively, use docker-compose to build and serve the image for production:

docker-compose up --build -d

The image will build and start, then detach from the terminal 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.