You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

56 lines
2.5 KiB

5 months ago
# Akkoma-FE
7 years ago
9 months ago
![English OK]( ![日本語OK](
5 months ago
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
6 years ago
# For Translators
5 months ago
The [Weblate UI]( is recommended for adding or modifying translations for Akkoma-FE.
10 months ago
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.
5 months ago
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.
6 years ago
5 months ago
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.
6 years ago
7 years ago
## Build Setup
``` bash
# install dependencies
6 years ago
npm install -g yarn
7 years ago
# 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
4 years ago
Edit config.json for configuration.
## Options
### Login methods
5 months ago
```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.