Pinafore-Web-Client-Frontend/README.md

# Pinafore [![Build Status](https://travis-ci.org/nolanlawson/pinafore.svg)](https://travis-ci.org/nolanlawson/pinafore) [![Greenkeeper badge](https://badges.greenkeeper.io/nolanlawson/pinafore.svg)](https://greenkeeper.io/)

An alternative web client for [Mastodon](https://joinmastodon.org), focused on speed and simplicity.

Pinafore is available at [pinafore.social](https://pinafore.social). Bleeding-edge releases are at [dev.pinafore.social](https://dev.pinafore.social).

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) to troubleshoot instance compatibility issues.

For updates and support, follow us at [@pinafore@mastodon.technology](https://mastodon.technology/@pinafore).

## 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](https://nodejs.org/en/) 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](https://github.com/nolanlawson/pinafore/blob/master/CONTRIBUTING.md) for 
how to run Pinafore in dev mode and run tests.

## Changelog

For a changelog, see the [GitHub releases](http://github.com/nolanlawson/pinafore/releases/).
docs: remove JS standard badge as it's not very relevant [skip ci] 2018-04-16 07:07:37 +02:00			`# Pinafore [![Build Status](https://travis-ci.org/nolanlawson/pinafore.svg)](https://travis-ci.org/nolanlawson/pinafore) [![Greenkeeper badge](https://badges.greenkeeper.io/nolanlawson/pinafore.svg)](https://greenkeeper.io/)`
docs(readme): add Greenkeeper badge 2018-04-14 18:41:56 +02:00
Fix Mastodon link (#364) 2018-06-03 22:36:33 +02:00			`An alternative web client for [Mastodon](https://joinmastodon.org), focused on speed and simplicity.`
add user guide and update readme 2018-04-02 08:15:52 +02:00
update readme 2018-04-02 08:18:50 +02:00			`Pinafore is available at [pinafore.social](https://pinafore.social). Bleeding-edge releases are at [dev.pinafore.social](https://dev.pinafore.social).`
add user guide and update readme 2018-04-02 08:15:52 +02:00
Add more admin notes (#407) [skip ci] 2018-07-02 19:35:23 +02: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) to troubleshoot instance compatibility issues.`
add user guide and update readme 2018-04-02 08:15:52 +02:00
add note to README about masto account [skip ci] 2018-04-21 19:59:52 +02:00			`For updates and support, follow us at [@pinafore@mastodon.technology](https://mastodon.technology/@pinafore).`

add user guide and update readme 2018-04-02 08:15:52 +02: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.`
update readme 2018-02-18 23:38:10 +01:00
outline goals and non-goals 2018-03-11 20:55:46 +01:00			`## 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`
update readme 2018-04-09 02:30:02 +02:00			`- Android/iOS apps (using Cordova or similar)`
outline goals and non-goals 2018-03-11 20:55:46 +01:00			`- Support Pleroma/non-Mastodon backends`
			`- i18n`
update readme 2018-03-21 16:39:06 +01:00			`- Offline search`
add CONTRIBUTING.md 2018-03-31 02:55:55 +02:00			`- Full emoji keyboard`
update readme 2018-04-05 03:33:14 +02:00			`- Keyboard shortcuts`
outline goals and non-goals 2018-03-11 20:55:46 +01:00
			`### 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`
update readme 2018-04-05 03:33:14 +02:00			`- Works offline in read-write mode (would require sophisticated sync logic)`
outline goals and non-goals 2018-03-11 20:55:46 +01:00
docs: move Building documentation to README [skip ci] 2018-04-15 18:48:52 +02:00			`## Building`
update readme 2018-02-18 23:38:10 +01:00
Update README.md 2018-08-25 22:04:41 +02:00			Pinafore requires [Node.js](https://nodejs.org/en/) v8+ and `npm`.

docs: move Building documentation to README [skip ci] 2018-04-15 18:48:52 +02:00			`To build Pinafore for production:`

			`npm install`
			`npm run build`
			`PORT=4002 npm start`

Added Dockerfile (#313) * Added Dockerfile * Better comments in Dockerfile * Added SIGINT handler * Keeping code-check happy * Keeping code-check happy v2 * Keeping code-check happy v2 2018-05-25 04:59:48 +02:00			`### Docker`

			`To build a docker image for production:`

			`docker build .`
			`docker run -d -p 4002:4002 [your-image]`

docs: move Building documentation to README [skip ci] 2018-04-15 18:48:52 +02:00			Now Pinafore is running at `localhost:4002`.

Update README.md 2018-08-25 22:04:41 +02: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)`
docs: move Building documentation to README [skip ci] 2018-04-15 18:48:52 +02:00
			`## 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.`
update readme [skip ci] 2018-05-04 18:19:44 +02:00
			`## Changelog`

			`For a changelog, see the [GitHub releases](http://github.com/nolanlawson/pinafore/releases/).`