pleroma-fe/README.md

# Pleroma-FE 

> Highly-customizable frontend designed for Pleroma.

![screenshot](./image-1.png)

# For Translators

To translate Pleroma-FE, use our weblate server: https://translate.pleroma.social/. If you need to add your language it should be added as a json file in [src/i18n/](https://git.pleroma.social/pleroma/pleroma-fe/blob/develop/src/i18n/) folder and added in a list within [src/i18n/languages.js](https://git.pleroma.social/pleroma/pleroma-fe/blob/develop/src/i18n/languages.js). 

Pleroma-FE will set your language by your browser locale, but you can change language in settings.

# For instance admins
You don't need to build Pleroma-FE yourself. Those using the Pleroma backend will be able to use it out of the box. Information of customizing PleromaFE settings/defaults is in our [guide](https://docs-develop.pleroma.social/frontend/CONFIGURATION/) and in case you want to build your own custom version there's [another](https://docs-develop.pleroma.social/frontend/HACKING/)

# Build Setup

``` bash
# install dependencies
npm install -g yarn
yarn

# serve with hot reload at localhost:8080
yarn dev

# build for production with minification
yarn build

# run unit tests
yarn unit
```

# For Contributors:

You can create file `/config/local.json` (see [example](https://git.pleroma.social/pleroma/pleroma-fe/blob/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

Set configuration settings in AdminFE, additionally you can edit config.json. For more details see [documentation](https://docs-develop.pleroma.social/frontend/CONFIGURATION/).
Use consistent naming for Pleroma-FE in README 2020-05-28 09:08:17 +00:00			`# Pleroma-FE`
Basic skeleton 2016-10-26 14:46:32 +00:00
Update README.md, image.png 2022-12-22 14:27:05 +00:00			`> Highly-customizable frontend designed for Pleroma.`
Basic skeleton 2016-10-26 14:46:32 +00:00
less John Paul "Scatman" Larkin content in the screenshot 2022-12-22 14:41:36 +00:00			`![screenshot](./image-1.png)`
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 README.md, image.png 2022-12-22 14:27:05 +00:00			`To translate Pleroma-FE, use our weblate server: https://translate.pleroma.social/. If you need to add your language it should be added as a json file in [src/i18n/](https://git.pleroma.social/pleroma/pleroma-fe/blob/develop/src/i18n/) folder and added in a list within [src/i18n/languages.js](https://git.pleroma.social/pleroma/pleroma-fe/blob/develop/src/i18n/languages.js).`
Add translation to readme. 2017-11-07 14:42:34 +00:00
Update README.md, image.png 2022-12-22 14:27:05 +00:00			`Pleroma-FE will set your language by your browser locale, but you can change language in settings.`
Update README.md 2017-01-19 16:51:27 +00:00
Update README.md, image.png 2022-12-22 14:27:05 +00:00			`# For instance admins`
			`You don't need to build Pleroma-FE yourself. Those using the Pleroma backend will be able to use it out of the box. Information of customizing PleromaFE settings/defaults is in our [guide](https://docs-develop.pleroma.social/frontend/CONFIGURATION/) and in case you want to build your own custom version there's [another](https://docs-develop.pleroma.social/frontend/HACKING/)`
Update README.md 2017-01-19 16:51:27 +00:00
Update README.md, image.png 2022-12-22 14:27:05 +00:00			`# Build Setup`
Basic skeleton 2016-10-26 14:46:32 +00:00
			``` bash
			`# install dependencies`
Update README.md 2017-02-19 21:15:42 +00:00			`npm install -g yarn`
			`yarn`
Basic skeleton 2016-10-26 14:46:32 +00:00
			`# serve with hot reload at localhost:8080`
Update README.md, image.png 2022-12-22 14:27:05 +00:00			`yarn dev`
Basic skeleton 2016-10-26 14:46:32 +00:00
			`# build for production with minification`
Update README.md, image.png 2022-12-22 14:27:05 +00:00			`yarn build`
Basic skeleton 2016-10-26 14:46:32 +00:00
			`# run unit tests`
Update README.md, image.png 2022-12-22 14:27:05 +00:00			`yarn unit`
Basic skeleton 2016-10-26 14:46:32 +00:00			```

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

			You can create file `/config/local.json` (see [example](https://git.pleroma.social/pleroma/pleroma-fe/blob/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.

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

Update README.md, image.png 2022-12-22 14:27:05 +00:00			`Set configuration settings in AdminFE, additionally you can edit config.json. For more details see [documentation](https://docs-develop.pleroma.social/frontend/CONFIGURATION/).`