akkoma-fe/README.md

# Akkoma-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)

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

The [Weblate UI](https://translate.akkoma.dev/projects/akkoma/pleroma-fe/) 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](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.

## Build Setup

Make sure you have [Node.js](https://nodejs.org/) installed. You can check `/.woodpecker.yml` for which node version the Akkoma CI currently uses.

``` bash
# 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](https://akkoma.dev/AkkomaGang/akkoma-fe/src/branch/develop/config/local.example.json)) 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.
Update config.example.json link and example domain 2023-09-24 00:34:30 +00:00			`# Akkoma-FE`
Basic skeleton 2016-10-26 14:46:32 +00:00
add language tags 2022-08-23 15:12:06 +00:00			`![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)`

update readme 2022-12-29 15:22:06 +00:00			`This is a fork of Akkoma-FE from the Pleroma project, with support for new Akkoma features such as:`
Update README with Akkoma stuff (#39) Reviewed-on: https://akkoma.dev/AkkomaGang/pleroma-fe/pulls/39 Co-authored-by: Norm <normandy@biribiri.dev> Co-committed-by: Norm <normandy@biribiri.dev> 2022-07-17 13:09:44 +00:00			`- MFM support via [marked-mfm](https://akkoma.dev/sfr/marked-mfm)`
			`- Custom emoji reactions`
Update README.md 2017-02-18 16:49:34 +00:00
Add translation to readme. 2017-11-07 14:42:34 +00:00			`# For Translators`

Update config.example.json link and example domain 2023-09-24 00:34:30 +00:00			`The [Weblate UI](https://translate.akkoma.dev/projects/akkoma/pleroma-fe/) is recommended for adding or modifying translations for Akkoma-FE.`
Update README.md with updated translation instructions 2022-07-28 23:56:48 +00:00
typo fix 2022-07-28 23:59:53 +00:00			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.
Update README.md with updated translation instructions 2022-07-28 23:56:48 +00:00
update readme 2022-12-29 15:22:06 +00:00			`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.`
Add translation to readme. 2017-11-07 14:42:34 +00:00
Update README.md 2017-01-19 16:51:27 +00:00			`# FOR ADMINS`

update readme 2022-12-29 15:22:06 +00:00			`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.`
Update README.md 2017-01-19 16:51:27 +00:00
Basic skeleton 2016-10-26 14:46:32 +00:00			`## Build Setup`

Add line to install Node.js For someone who isn't used to building fe things like this, it's not always clear to install Node.js or what version. A line has been added to the installation instructions pointing to resources where to get it and what version to use. For version I point to the woodpecker config because that is what the CI uses and therefor always "tested". There was a file .node-version who contained a node version, but this was seriously outdated and removing it didn't seem to break anything. Assuming it indeed doesn't do anything any more, it seems better to remove to avoid confusion. 2024-08-03 07:54:14 +00:00			Make sure you have [Node.js](https://nodejs.org/) installed. You can check `/.woodpecker.yml` for which node version the Akkoma CI currently uses.

Basic skeleton 2016-10-26 14:46:32 +00:00			``` bash
			`# install dependencies`
Use corepack in build instructions 2023-09-24 00:33:46 +00:00			`corepack enable`
Update README.md 2017-02-19 21:15:42 +00:00			`yarn`
Basic skeleton 2016-10-26 14:46:32 +00:00
			`# serve with hot reload at localhost:8080`
			`npm run dev`

			`# build for production with minification`
			`npm run build`

			`# run unit tests`
			`npm run unit`
			```

Quality of Frontend Developer's Life: here to stay 2018-12-11 15:45:25 +00:00			`# For Contributors:`

Update config.example.json link and example domain 2023-09-24 00:34:30 +00:00			You can create file `/config/local.json` (see [example](https://akkoma.dev/AkkomaGang/akkoma-fe/src/branch/develop/config/local.example.json)) to enable some convenience dev options:
Quality of Frontend Developer's Life: here to stay 2018-12-11 15:45:25 +00:00
			* `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.

Make scope options optional, refactoring. 2018-06-08 13:25:48 +00:00			`# Configuration`

final touches 2019-03-30 10:42:42 +00:00			`Edit config.json for configuration.`
Add login form back in. 2018-11-07 15:56:12 +00:00
			`## Options`

			`### Login methods`

Update config.example.json link and example domain 2023-09-24 00:34:30 +00:00			```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.