pinafore/README.md

118 lines
3.7 KiB
Markdown
Raw Permalink Normal View History

# Pinafore [![Build status](https://circleci.com/gh/nolanlawson/pinafore.svg?style=svg)](https://app.circleci.com/pipelines/gh/nolanlawson/pinafore)
2018-04-14 17:41:56 +01:00
2018-06-03 21:36:33 +01:00
An alternative web client for [Mastodon](https://joinmastodon.org), focused on speed and simplicity.
2018-04-02 07:15:52 +01:00
2018-12-19 04:50:30 +00:00
Pinafore is available at [pinafore.social](https://pinafore.social). Beta releases are at [dev.pinafore.social](https://dev.pinafore.social).
2018-04-02 07:15:52 +01:00
2018-12-19 04:50:30 +00:00
See the [user guide](https://github.com/nolanlawson/pinafore/blob/master/docs/User-Guide.md) for basic usage. See the [admin guide](https://github.com/nolanlawson/pinafore/blob/master/docs/Admin-Guide.md) if Pinafore cannot connect to your instance.
2018-04-02 07:15:52 +01:00
2018-12-19 04:50:30 +00:00
For updates and support, follow [@pinafore@mastodon.technology](https://mastodon.technology/@pinafore).
2018-04-02 07:15:52 +01: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 22:38:10 +00:00
2018-03-11 19:55:46 +00:00
## Goals and non-goals
### Goals
- Support the most common use cases
2018-12-19 04:50:30 +00:00
- Small page weight
- Fast even on low-end devices
- Accessibility
- Offline support in read-only mode
2018-03-11 19:55:46 +00:00
- 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
2018-03-11 19:55:46 +00:00
2018-12-19 04:50:30 +00:00
### Secondary / possible future goals
2018-03-11 19:55:46 +00:00
2018-12-19 04:50:30 +00:00
- Serve as an alternative frontend tied to a particular instance
2018-03-21 15:39:06 +00:00
- Offline search
2018-03-11 19:55:46 +00:00
### Non-goals
- Supporting old browsers, proxy browsers, or text-based browsers
- React Native / NativeScript / hybrid-native version
2018-12-19 04:50:30 +00:00
- Android/iOS apps (using Cordova or similar)
2018-03-11 19:55:46 +00:00
- Full functionality with JavaScript disabled
- Emoji support beyond the built-in system emoji
- Multi-column support
- Admin/moderation panel
2018-12-19 04:50:30 +00:00
- Offline support in read-write mode (would require sophisticated sync logic)
2018-03-11 19:55:46 +00:00
## Building
2018-02-18 22:38:10 +00:00
2022-05-01 21:16:10 +01:00
Pinafore requires [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com).
2018-08-25 21:04:41 +01:00
To build Pinafore for production, first install dependencies:
yarn --production --pure-lockfile
Then build:
yarn build
Then run:
PORT=4002 node server.js
### Docker
2018-12-19 04:50:30 +00:00
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`.
2018-08-25 21:04:41 +01:00
### 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](https://developer.mozilla.org/en-US/docs/Web/HTTP/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](https://github.com/nolanlawson/pinafore/blob/master/CONTRIBUTING.md) for
how to run Pinafore in dev mode and run tests.
2018-05-04 17:19:44 +01:00
## Changelog
For a changelog, see the [GitHub releases](http://github.com/nolanlawson/pinafore/releases/).
2018-12-19 04:50:30 +00:00
For a list of breaking changes, see [BREAKING_CHANGES.md](https://github.com/nolanlawson/pinafore/blob/master/BREAKING_CHANGES.md).
2018-12-19 04:50:30 +00:00
## What's with the name?
Pinafore is named after the [Gilbert and Sullivan play](https://en.wikipedia.org/wiki/Hms_pinafore). The [soundtrack](https://www.allmusic.com/album/gilbert-sullivan-hms-pinafore-1949-mw0001830483) is very good.