05a3b2d31f
The `node:alpine` Docker image appears to have recently been updated to point to Node 17, breaking new builds of Pinafore. This commit explicitly specifies Node 16 until the underlying reason for the build failure on 17+ can be fixed. |
||
|---|---|---|
| .circleci | ||
| .husky | ||
| bin | ||
| docs | ||
| src | ||
| static | ||
| tests | ||
| webpack | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .testcaferc.json | ||
| .vercelignore | ||
| BREAKING_CHANGES.md | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| docker-compose.yml | ||
| package.json | ||
| server.js | ||
| vercel.json | ||
| yarn.lock | ||
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
- 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.