aa69e651ac
* Wrap LONG posts with spoilers Some ActivityPub software facilitates long form blog posts being pushed out onto timelines. Some ActivityPub software have toot lengths which are much larger than Mastodon's default of 500. This wraps spoiler tags around those statuses. * fix lint, extract consts * extract consts to separate file * fix test hopefully * Revert "fix test hopefully" This reverts commit 7d8e2671ad158b317f6f75a7dd5dacac9e12cf80. * Fix failing test * Revert "Fix failing test" This reverts commit 15b06e11589b49979ca5eb85b7fe5c7510a62ba7. * Revert "Revert "fix test hopefully"" This reverts commit d3776bc9d64dcfd209a307a0639d33cbe6ca3884. * measure text after shortening URLs |
||
---|---|---|
bin | ||
docs | ||
fixtures | ||
original-static | ||
scss | ||
src | ||
src-build | ||
static | ||
tests | ||
thirdparty/font-awesome-svg-png | ||
webpack | ||
.editorconfig | ||
.gitignore | ||
.travis.yml | ||
CONTRIBUTING.md | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
inline-script.js | ||
package-lock.json | ||
package.json | ||
webpack.config.js |
README.md
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
- 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.