README.md 1.95 KB
Newer Older
lain's avatar
lain committed
1 2
# pleroma_fe

3
> A single column frontend for both Pleroma and GS servers.
lain's avatar
lain committed
4

5
![screenshot](https://i.imgur.com/DJVqSJ0.png)
lambadalambda's avatar
lambadalambda committed
6

Roger Braun's avatar
Roger Braun committed
7 8
# For Translators

Francis Dinh's avatar
Francis Dinh committed
9
To translate Pleroma-FE, add your language to [src/i18n/messages.js](https://git.pleroma.social/pleroma/pleroma-fe/blob/develop/src/i18n/messages.js). Pleroma-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.
Roger Braun's avatar
Roger Braun committed
10

lambadalambda's avatar
lambadalambda committed
11 12
# FOR ADMINS

Francis Dinh's avatar
Francis Dinh committed
13 14
You don't need to build Pleroma-FE yourself. Those using the Pleroma backend will be able to use it out of the box.
For the GNU social backend, check out https://git.pleroma.social/pleroma/pleroma-fe/wikis/dual-boot-with-qvitter to see how to run Pleroma-FE and Qvitter at the same time.
lambadalambda's avatar
lambadalambda committed
15

lain's avatar
lain committed
16 17 18 19
## Build Setup

``` bash
# install dependencies
lambadalambda's avatar
lambadalambda committed
20 21
npm install -g yarn
yarn
lain's avatar
lain committed
22 23 24 25 26 27 28 29 30 31 32

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# run unit tests
npm run unit
```

33 34 35 36 37 38 39 40 41
# 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.

42 43
# Configuration

HJ's avatar
HJ committed
44
Edit config.json for configuration.
lain's avatar
lain committed
45 46 47 48 49 50

## 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.