nolanlawson
/
pinafore
forked from cybrespace/pinafore
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Cybre pinafore fork
990 Commits 2 Branches 0 Tags 127 MiB
JavaScript 43%
HTML 37.8%
PLpgSQL 17%
CSS 2.1%
Go to file
greenkeeper[bot] c946000b84 Update webpack-bundle-analyzer to the latest version 🚀 (#311) 
* fix(package): update webpack-bundle-analyzer to version 2.13.0

* chore(package): update lockfile

https://npm.im/greenkeeper-lockfile
 		2018-05-22 12:03:12 -07:00
assets add manifest description (#262) 2018-05-03 21:24:18 -07:00
bin add option to copy link to clipboard (#289) 2018-05-12 15:00:11 -07:00
docs Add CSP (#119) 2018-04-14 15:50:16 -07:00
fixtures travis: use special pinafore user for postgres 2018-04-10 18:39:56 -07:00
original-assets add windows icons, optimize icons 2018-03-22 20:43:16 -07:00
routes fix timelineType state read (#310) 2018-05-18 18:33:20 -07:00
scss fix container focus rendering issue on Edge (#256) 2018-05-02 20:35:05 -07:00
templates add option to copy link to clipboard (#289) 2018-05-12 15:00:11 -07:00
tests add ability to pin and unpin statuses (#235) 2018-04-29 12:28:44 -07:00
.gitignore Add CSP (#119) 2018-04-14 15:50:16 -07:00
.travis.yml update npm in travis (#307) 2018-05-17 18:19:56 -07:00
CONTRIBUTING.md docs(): add notes on debugging webpack 2018-05-01 17:00:34 -07:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
README.md update readme 2018-05-04 09:19:44 -07:00
inline-script.js fix themes (#199) 2018-04-21 00:33:42 -07:00
package-lock.json Update webpack-bundle-analyzer to the latest version 🚀 (#311) 2018-05-22 12:03:12 -07:00
package.json Update webpack-bundle-analyzer to the latest version 🚀 (#311) 2018-05-22 12:03:12 -07:00
server.js add zopfli/brotli encoding (#200) 2018-04-21 07:06:08 -07:00
webpack.client.config.js isolate autosuggestion state (#273) 2018-05-06 16:25:17 -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.

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

To build Pinafore for production:

npm install
npm run build
PORT=4002 npm start

Now Pinafore is running at localhost:4002.

Pinafore requires Node.js v8+.

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.