Cybre pinafore fork
Go to file
Nolan Lawson 0402d825bc
chore(package): update lodash-es to version 4.17.11 (#557)
* chore(package): update lodash-es to version 4.17.11

* chore(package): update lockfile package-lock.json
2018-09-22 23:08:17 -07:00
assets add manifest description (#262) 2018-05-03 21:24:18 -07:00
bin use Mastodon v2.5.0 for testing (#566) 2018-09-22 22:19:02 -07:00
docs Add instructions for admins to achieve Pinafore compatibility (#406) 2018-07-02 10:33:44 -07:00
fixtures use Mastodon v2.5.0 for testing (#566) 2018-09-22 22:19:02 -07:00
original-assets add windows icons, optimize icons 2018-03-22 20:43:16 -07:00
routes rename darkscarlet and darkpink to Punk and Riot 2018-09-22 16:42:57 -07:00
scss rename darkscarlet and darkpink to Punk and Riot 2018-09-22 16:42:57 -07:00
templates update generated HTML file 2018-09-22 16:49:49 -07:00
tests Update standard to the latest version 🚀 (#519) 2018-08-29 21:42:57 -07:00
.gitignore Add CSP (#119) 2018-04-14 15:50:16 -07:00
.travis.yml tests: use `npm ci || npm i` in travis (#373) 2018-06-08 09:27:00 -07:00
CONTRIBUTING.md update to mastodon 2.4.0 in travis (#371) 2018-06-07 15:26:47 -07:00
Dockerfile Fixing Dockerfile (#440) 2018-08-18 21:20:33 -07:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
README.md Update README.md 2018-08-25 13:04:41 -07:00
inline-script.js rename darkscarlet and darkpink to Punk and Riot 2018-09-22 16:42:57 -07:00
package-lock.json chore(package): update lodash-es to version 4.17.11 (#557) 2018-09-22 23:08:17 -07:00
package.json chore(package): update lodash-es to version 4.17.11 (#557) 2018-09-22 23:08:17 -07:00
server.js Update standard to the latest version 🚀 (#519) 2018-08-29 21:42:57 -07:00
webpack.client.config.js tweak timeline loading and worker dev mode (#525) 2018-08-31 09:12:48 -07:00
webpack.server.config.js use standard 2018-02-08 22:29:29 -08:00

README.md

Pinafore Build Status Greenkeeper badge

An alternative web client for Mastodon, focused on speed and simplicity.

Pinafore is available at pinafore.social. Bleeding-edge releases are at dev.pinafore.social.

See the user guide for basic usage. See the admin guide to troubleshoot instance compatibility issues.

For updates and support, follow us at @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
  • 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
  • Android/iOS apps (using Cordova or similar)
  • Support Pleroma/non-Mastodon backends
  • i18n
  • Offline search
  • Full emoji keyboard
  • Keyboard shortcuts

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
  • Works offline 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)

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.