amputoma-fe/README.md

47 lines
1.5 KiB
Markdown
Raw Normal View History

2025-01-18 07:32:53 +01:00
# Amputoma-FE
2016-10-26 16:46:32 +02:00
2025-01-18 07:32:53 +01:00
This is a fork of akkoma-FE, with support for new amputoma features such as:
- ulith support
- something else
2017-02-18 17:49:34 +01:00
2017-11-07 15:42:34 +01:00
# For Translators
2025-01-18 07:32:53 +01:00
The [Weblate UI](https://translate.amputoma.dev/projects/amputoma/pleroma-fe/) is recommended for adding or modifying translations for amputoma-FE.
2025-01-18 07:32:53 +01: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 if it doesn't already exist there.
2025-01-18 07:32:53 +01:00
Amputoma-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.
2017-11-07 15:42:34 +01:00
2017-01-19 17:51:27 +01:00
# FOR ADMINS
2025-01-18 07:32:53 +01:00
To use Amputoma-FE in a pleroma thing, build from source >:3 and then copy the build files from /dist to /static/frontends/pleroma-fe/stable on your server
2017-01-19 17:51:27 +01:00
2016-10-26 16:46:32 +02:00
## Build Setup
2025-01-18 07:32:53 +01:00
Make sure you have [Node.js](https://nodejs.org/) installed. You can check `/.woodpecker.yml` for which node version the amputoma CI currently uses.
2016-10-26 16:46:32 +02:00
``` bash
# install dependencies
2023-09-24 02:33:46 +02:00
corepack enable
2017-02-19 22:15:42 +01:00
yarn
2016-10-26 16:46:32 +02: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
```
# Configuration
2019-03-30 11:42:42 +01:00
Edit config.json for configuration.
2018-11-07 16:56:12 +01:00
## 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.