Updated README.md to present FediLove
This commit is contained in:
parent
bc5fd8eb4e
commit
3d5e797755
69
README.md
69
README.md
|
|
@ -1,16 +1,19 @@
|
|||
# Pinafore [](https://app.circleci.com/pipelines/gh/nolanlawson/pinafore)
|
||||
# FediLove
|
||||
|
||||
An alternative web client for [Mastodon](https://joinmastodon.org), focused on speed and simplicity.
|
||||
A web client to turn [Mastodon](https://joinmastodon.org) into a **Federated Meeting and Dating** platform.
|
||||
This client uses **Mastodon API** to implement dating App features such as: **Meeting people, Profile setup, Preferences, Matching, Chating, Sharing**
|
||||
|
||||
Pinafore is available at [pinafore.social](https://pinafore.social). Beta releases are at [dev.pinafore.social](https://dev.pinafore.social).
|
||||
It is a fork of [Pinafore](https://github.com/nolanlawson/pinafore)
|
||||
|
||||
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) if Pinafore cannot connect to your instance.
|
||||
FediLove is available at [love.nogafam.es](https://love.nogafam.es).
|
||||
|
||||
For updates and support, follow [@pinafore@mastodon.technology](https://mastodon.technology/@pinafore).
|
||||
See the [user guide](https://git.nogafam.es/nogafam/fedilove-ui/src/branch/master/docs/User-Guide.md) for basic usage. See the [admin guide](https://git.nogafam.es/nogafam/fedilove-ui/src/branch/master/docs/Admin-Guide.md) if FediLove cannot connect to your instance.
|
||||
|
||||
For updates and support, follow [@admin@masto.nogafam.es](https://masto.nogafam.es/@admin).
|
||||
|
||||
## Browser support
|
||||
|
||||
Pinafore supports the latest versions of the following browsers:
|
||||
FediLove supports the latest versions of the following browsers:
|
||||
|
||||
- Chrome
|
||||
- Edge
|
||||
|
|
@ -19,42 +22,11 @@ Pinafore supports the latest versions of the following browsers:
|
|||
|
||||
Compatible versions of each (Opera, Brave, Samsung, etc.) should be fine.
|
||||
|
||||
## Goals and non-goals
|
||||
|
||||
### Goals
|
||||
|
||||
- Support the most common use cases
|
||||
- Small page weight
|
||||
- Fast even on low-end devices
|
||||
- Accessibility
|
||||
- Offline support in read-only mode
|
||||
- Progressive Web App features
|
||||
- Multi-instance support
|
||||
- Support latest versions of Chrome, Edge, Firefox, and Safari
|
||||
- Support non-Mastodon instances (e.g. Pleroma) as well as possible
|
||||
- Internationalization
|
||||
|
||||
### Secondary / possible future goals
|
||||
|
||||
- Serve as an alternative frontend tied to a particular instance
|
||||
- Offline search
|
||||
|
||||
### Non-goals
|
||||
|
||||
- Supporting old browsers, proxy browsers, or text-based browsers
|
||||
- React Native / NativeScript / hybrid-native version
|
||||
- Android/iOS apps (using Cordova or similar)
|
||||
- Full functionality with JavaScript disabled
|
||||
- Emoji support beyond the built-in system emoji
|
||||
- Multi-column support
|
||||
- Admin/moderation panel
|
||||
- Offline support in read-write mode (would require sophisticated sync logic)
|
||||
|
||||
## Building
|
||||
|
||||
Pinafore requires [Node.js](https://nodejs.org/en/) v8+ and [Yarn](https://yarnpkg.com).
|
||||
FediLove requires [Node.js](https://nodejs.org/en/) v8+ and [Yarn](https://yarnpkg.com).
|
||||
|
||||
To build Pinafore for production, first install dependencies:
|
||||
To build FediLove for production, first install dependencies:
|
||||
|
||||
yarn --production --pure-lockfile
|
||||
|
||||
|
|
@ -73,7 +45,7 @@ To build a Docker image for production:
|
|||
docker build .
|
||||
docker run -d -p 4002:4002 [your-image]
|
||||
|
||||
Now Pinafore is running at `localhost:4002`.
|
||||
Now FediLove is running at `localhost:4002`.
|
||||
|
||||
### docker-compose
|
||||
|
||||
|
|
@ -85,13 +57,13 @@ The image will build and start, then detach from the terminal running at `localh
|
|||
|
||||
### Updating
|
||||
|
||||
To keep your version of Pinafore up to date, you can use `git` to check out the latest tag:
|
||||
To keep your version of FediLove up to date, you can use `git` to check out the latest tag:
|
||||
|
||||
git checkout $(git tag -l | sort -Vr | head -n 1)
|
||||
|
||||
### Exporting
|
||||
|
||||
Pinafore is a static site. When you run `yarn build`, static files will be
|
||||
FediLove is a static site. When you run `yarn build`, static files will be
|
||||
written to `__sapper__/export`.
|
||||
|
||||
In theory you could host these static files yourself (e.g. using nginx or Apache), but
|
||||
|
|
@ -103,15 +75,6 @@ which are an important security feature.
|
|||
|
||||
## 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.
|
||||
See [CONTRIBUTING.md](https://git.nogafam.es/nogafam/fedilove-ui/src/branch/master/CONTRIBUTING.md) for
|
||||
how to run FediLove in dev mode and run tests.
|
||||
|
||||
## Changelog
|
||||
|
||||
For a changelog, see the [GitHub releases](http://github.com/nolanlawson/pinafore/releases/).
|
||||
|
||||
For a list of breaking changes, see [BREAKING_CHANGES.md](https://github.com/nolanlawson/pinafore/blob/master/BREAKING_CHANGES.md).
|
||||
|
||||
## What's with the name?
|
||||
|
||||
Pinafore is named after the [Gilbert and Sullivan play](https://en.wikipedia.org/wiki/Hms_pinafore). The [soundtrack](https://www.allmusic.com/album/gilbert-sullivan-hms-pinafore-1949-mw0001830483) is very good.
|
||||
|
|
|
|||
Loading…
Reference in New Issue