2018-04-15 22:07:37 -07:00
|
|
|
# Pinafore [](https://travis-ci.org/nolanlawson/pinafore) [](https://greenkeeper.io/)
|
2018-04-14 16:41:56 +00:00
|
|
|
|
2018-04-01 23:15:52 -07:00
|
|
|
An alternative web client for [Mastodon](https://joinmastodon.org]), focused on speed and simplicity.
|
|
|
|
|
|
2018-04-01 23:18:50 -07:00
|
|
|
Pinafore is available at [pinafore.social](https://pinafore.social). Bleeding-edge releases are at [dev.pinafore.social](https://dev.pinafore.social).
|
2018-04-01 23:15:52 -07:00
|
|
|
|
2018-04-01 23:18:50 -07:00
|
|
|
See the [user guide](https://github.com/nolanlawson/pinafore/blob/master/docs/User-Guide.md) for basic usage.
|
2018-04-01 23:15:52 -07:00
|
|
|
|
2018-04-21 10:59:52 -07:00
|
|
|
For updates and support, follow us at [@pinafore@mastodon.technology](https://mastodon.technology/@pinafore).
|
|
|
|
|
|
2018-04-01 23:15:52 -07:00
|
|
|
## 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.
|
2018-02-18 14:38:10 -08:00
|
|
|
|
2018-03-11 12:55:46 -07:00
|
|
|
## Goals and non-goals
|
|
|
|
|
|
|
|
|
|
### Goals
|
|
|
|
|
|
|
|
|
|
- Support the most common use cases
|
|
|
|
|
- Fast even on low-end phones
|
|
|
|
|
- Works offline in read-only mode
|
|
|
|
|
- Progressive Web App features
|
|
|
|
|
- Multi-instance support
|
|
|
|
|
- Support latest versions of Chrome, Edge, Firefox, and Safari
|
|
|
|
|
- a11y (keyboard navigation, screen readers)
|
|
|
|
|
|
|
|
|
|
### Possible future goals
|
|
|
|
|
|
|
|
|
|
- Works as an alternative frontend self-hosted by instances
|
2018-04-08 17:30:02 -07:00
|
|
|
- Android/iOS apps (using Cordova or similar)
|
2018-03-11 12:55:46 -07:00
|
|
|
- Support Pleroma/non-Mastodon backends
|
|
|
|
|
- i18n
|
2018-03-21 08:39:06 -07:00
|
|
|
- Offline search
|
2018-03-30 17:55:55 -07:00
|
|
|
- Full emoji keyboard
|
2018-04-04 18:33:14 -07:00
|
|
|
- Keyboard shortcuts
|
2018-03-11 12:55:46 -07:00
|
|
|
|
|
|
|
|
### Non-goals
|
|
|
|
|
|
|
|
|
|
- Supporting old browsers, proxy browsers, or text-based browsers
|
|
|
|
|
- React Native / NativeScript / hybrid-native version
|
|
|
|
|
- Full functionality with JavaScript disabled
|
|
|
|
|
- Emoji support beyond the built-in system emoji
|
|
|
|
|
- Multi-column support
|
|
|
|
|
- Admin/moderation panel
|
2018-04-04 18:33:14 -07:00
|
|
|
- Works offline in read-write mode (would require sophisticated sync logic)
|
2018-03-11 12:55:46 -07:00
|
|
|
|
2018-04-15 09:48:52 -07:00
|
|
|
## Building
|
2018-02-18 14:38:10 -08:00
|
|
|
|
2018-04-15 09:48:52 -07:00
|
|
|
To build Pinafore for production:
|
|
|
|
|
|
|
|
|
|
npm install
|
|
|
|
|
npm run build
|
|
|
|
|
PORT=4002 npm start
|
|
|
|
|
|
2018-05-25 04:59:48 +02:00
|
|
|
### Docker
|
|
|
|
|
|
|
|
|
|
To build a docker image for production:
|
|
|
|
|
|
|
|
|
|
docker build .
|
|
|
|
|
docker run -d -p 4002:4002 [your-image]
|
|
|
|
|
|
2018-04-15 09:48:52 -07:00
|
|
|
Now Pinafore is running at `localhost:4002`.
|
|
|
|
|
|
|
|
|
|
Pinafore requires [Node.js](https://nodejs.org/en/) v8+.
|
|
|
|
|
|
|
|
|
|
## Developing and testing
|
|
|
|
|
|
|
|
|
|
See [CONTRIBUTING.md](https://github.com/nolanlawson/pinafore/blob/master/CONTRIBUTING.md) for
|
|
|
|
|
how to run Pinafore in dev mode and run tests.
|
2018-05-04 09:19:44 -07:00
|
|
|
|
|
|
|
|
## Changelog
|
|
|
|
|
|
|
|
|
|
For a changelog, see the [GitHub releases](http://github.com/nolanlawson/pinafore/releases/).
|
