Update 'README.md'

This commit is contained in:
fox 2023-03-09 05:07:27 +00:00
parent 9196d4c192
commit 4851d10c1e

View file

@ -1,22 +1,29 @@
# Akkoma-FE
# Akkounfucked-fe
![English OK](https://img.shields.io/badge/English-OK-blueviolet) ![日本語OK](https://img.shields.io/badge/%E6%97%A5%E6%9C%AC%E8%AA%9E-OK-blueviolet)
Changes:
- Restore the shoutbox and pleroma chats interfaces and the scripts to talk to the server endpoints,
- Fix cropped emojis and tooltips from content div restraints (fc2ce67e40) Caveat: it could allow misskey markdown to escape the post and take over the screen, a real fix to just limit MFM would be a nice addition,
- Allow replying to a post with a more open visibility than it previously had (you can take a private thread into public)
- Local storage based draft posts
This is a fork of Akkoma-FE from the Pleroma project, with support for new Akkoma features such as:
- MFM support via [marked-mfm](https://akkoma.dev/sfr/marked-mfm)
- Custom emoji reactions
# For Translators
Visual Changes:
- Repeats are renamed to boosts, quotes are renamed to quote boosts in order to align with mastodon.
- Align post action buttons back to the left, like pleroma and older akkoma versions.
- Emojis are upsized to 50px from 38px (b40a02b6df),
- Remove blurhash nsfw images completely (Should have been toggleable by the instance admin),
- Remove language selector (Again, should have been toggleable by the instance admin)
The [Weblate UI](https://translate.akkoma.dev/projects/akkoma/pleroma-fe/) is recommended for adding or modifying translations for Akkoma-FE.
Intended/possible Future Changes:
- Allow "Keep Picker Open" for reactions.
- I would like to make draft posts better and implement them into a server side table, a bad but low effort way could be to use the scheduled posts table and set the post date as many years in the future and the privacy as direct by default.
- Something else I wanted to do but can't remember now.
Alternatively, edit/create `src/i18n/$LANGUAGE_CODE.json` (where `$LANGUAGE_CODE` is the [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your language), then add your language to [src/i18n/messages.js](https://akkoma.dev/AkkomaGang/pleroma-fe/src/branch/develop/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](https://docs.akkoma.dev/stable/administration/CLI_tasks/frontend/) CLI task to install Akkoma-FE, then modify your configuration as described in the [Frontend Management](https://docs.akkoma.dev/stable/configuration/frontend_management/) doc.
You need to build the front end and place it in /opt/akkoma/instance/static/frontends/youjo-fe/stable (from source install)
Install adminfe and pleromafe first, then you will be able to enter adminfe and change the stock front end to youjo-fe
## Build Setup