d198250eab
* chore: switch to yarn BREAKING CHANGE: Pinafore is now using yarn rather than npm, so those who self-host will need to stop running e.g. `npm install` and run `yarn install` instead. * install latest yarn |
||
|---|---|---|
| bin | ||
| docs | ||
| src | ||
| static | ||
| tests | ||
| webpack | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| webpack.config.js | ||
| yarn.lock | ||
Pinafore 
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:
yarn
yarn 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:
yarn 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.