mirrors
/
semaphore
mirror of https://github.com/NickColley/semaphore.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Accessible, simple and fast web client for Mastodon
1,056 Commits 4 Branches 1 Tag 146 MiB
JavaScript 63.1%
HTML 34.5%
SCSS 2.3%
Go to file
Nolan Lawson 092d9e98a5
fix typo in SCSS (#430) 		2018-08-17 21:51:26 -07:00
assets add manifest description (#262) 2018-05-03 21:24:18 -07:00
bin add "reply all" icon (#392) 2018-06-14 08:42:55 -07:00
docs Add instructions for admins to achieve Pinafore compatibility (#406) 2018-07-02 10:33:44 -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 add placeholder to "add instance" input (#427) 2018-08-16 22:15:22 -07:00
scss fix typo in SCSS (#430) 2018-08-17 21:51:26 -07:00
templates fix typo in SCSS (#430) 2018-08-17 21:51:26 -07:00
tests remove useless aria-hidden (#386) 2018-06-10 19:49:39 -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 Added Dockerfile (#313) 2018-05-24 19:59:48 -07:00
LICENSE add footer and license 2018-03-07 09:25:07 -08:00
README.md Add more admin notes (#407) 2018-07-02 10:35:23 -07:00
inline-script.js fix themes (#199) 2018-04-21 00:33:42 -07:00
package-lock.json 0.5.2 2018-08-17 07:50:15 -07:00
package.json 0.5.2 2018-08-17 07:50:15 -07:00
server.js Added Dockerfile (#313) 2018-05-24 19:59:48 -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. 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

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.

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.