FE for neckbeard.xyz
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.

49 lines
1.8 KiB

4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
1 year ago
  1. # Pleroma-FE
  2. > A single column frontend designed for Pleroma.
  3. ![screenshot](/uploads/796c5ecf985ed1e2b0943ee0df131ed0/DJVqSJ0.png)
  4. # For Translators
  5. 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.
  6. # FOR ADMINS
  7. You don't need to build Pleroma-FE yourself. Those using the Pleroma backend will be able to use it out of the box.
  8. ## Build Setup
  9. ``` bash
  10. # install dependencies
  11. npm install -g yarn
  12. yarn
  13. # serve with hot reload at localhost:8080
  14. npm run dev
  15. # build for production with minification
  16. npm run build
  17. # run unit tests
  18. npm run unit
  19. ```
  20. # For Contributors:
  21. 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:
  22. * `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.
  23. * `staticConfigPreference`: makes FE's `/static/config.json` take preference of BE-served `/api/statusnet/config.json`. Only works in dev mode.
  24. 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.
  25. # Configuration
  26. Edit config.json for configuration.
  27. ## Options
  28. ### Login methods
  29. ```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.