akkoma-fe/README.md

3.8 KiB

notfire's modified version of akkoma-fe for iceshrimp.net with some personal qol stuff

list of changes in this fork:

  • additional confirmations for:
    • post visibility (choose direct, private, unlisted, public, local)
    • posting with an attachment marked sensitive but no cw
  • biting:
    • users
    • notes
    • notification support for both
  • make boosts follow default visibility
  • notification sounds:
    • disabled by default, includes the misskey notif sound if enabled
    • custom ones (overriding the default) that can be randomly picked from
    • custom ones for certain users
    • volume controls for all sounds individually
  • rename "repeats" to "boosts"
  • add toggle for deduping boosts (this was done by default upstream)
  • raise limits:
    • polls can now have up to 20 options instead of 4
    • polls can now last anywhere from 1 second to 1000 years
  • optional alternate gravestone when using websockets that still shows post content but removes buttons
  • filters for reactions:
    • matching by regex, domain-specific, or catch-all
    • filters the actual reactions to post as well as notifications

Akkoma-FE

English OK 日本語OK

This is a fork of Akkoma-FE from the Pleroma project, with support for new Akkoma features such as:

  • MFM support via marked-mfm
  • Custom emoji reactions

For Translators

The Weblate UI is recommended for adding or modifying translations for Akkoma-FE.

Alternatively, edit/create src/i18n/$LANGUAGE_CODE.json (where $LANGUAGE_CODE is the ISO 639-1 code for your language), then add your language to src/i18n/messages.js if it doesn't already exist there.

Akkoma-FE will set your language by your browser locale, but you can temporarily force it in the code by changing the locale in main.js.

FOR ADMINS

To use Akkoma-FE in Akkoma, use the frontend CLI task to install Akkoma-FE, then modify your configuration as described in the Frontend Management doc.

Build Setup

Make sure you have Node.js installed. You can check /.woodpecker.yml for which node version the Akkoma CI currently uses.

# install dependencies
corepack enable
yarn

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# run unit tests
npm run unit

For Contributors:

You can create file /config/local.json (see example) to enable some convenience dev options:

  • target: makes local dev server redirect to some existing instance's BE instead of local BE, useful for testing things in near-production environment and searching for real-life use-cases.
  • staticConfigPreference: makes FE's /static/config.json take preference of BE-served /api/statusnet/config.json. Only works in dev mode.

FE Build process also leaves current commit hash in global variable ___pleromafe_commit_hash so that you can easily see which pleroma-fe commit instance is running, also helps pinpointing which commit was used when FE was bundled into BE.

Configuration

Edit config.json for configuration.

Options

Login methods

loginMethod can be set to either password (the default) or token, which will use the full oauth redirection flow, which is useful for SSO situations.