copyleftie
/
pinafore
1
0
Fork 0
Code Issues Pull Requests Releases Activity
Pinafore’s development branch, with some opinionated themes
864 Commits 4 Branches 0 Tags 130 MiB
JavaScript 56.5%
HTML 40.3%
CSS 2.8%
Shell 0.3%
Go to file
Nolan Lawson 0e54e15f72 0.2.1 2018-04-15 22:08:28 -07:00
assets set up deploy dev/prod scripts 2018-04-04 18:33:08 -07:00
bin mute and unmute accounts (#127) 2018-04-14 22:18:48 -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 only show "you are offline" notification once (#137) 2018-04-15 16:00:16 -07:00
scss add toot-cafe theme (#108) 2018-04-14 09:43:30 -07:00
templates mute and unmute accounts (#127) 2018-04-14 22:18:48 -07:00
tests mute and unmute accounts (#127) 2018-04-14 22:18:48 -07:00
.gitignore Add CSP (#119) 2018-04-14 15:50:16 -07:00
.travis.yml travis: make deploy-dev-trais an allowed failure 2018-04-14 22:09:38 -07:00
CONTRIBUTING.md docs: move Building documentation to README 2018-04-15 09:48:52 -07:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
README.md docs: remove JS standard badge as it's not very relevant 2018-04-15 22:07:37 -07:00
inline-script.js Add CSP (#119) 2018-04-14 15:50:16 -07:00
package-lock.json 0.2.1 2018-04-15 22:08:28 -07:00
package.json 0.2.1 2018-04-15 22:08:28 -07:00
server.js use full helmet() middleware (#135) 2018-04-15 15:39:45 -07:00
webpack.client.config.js simplify webpack config (#124) 2018-04-14 18:20:21 -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.

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.