Pleroma frontend
Go to file
Henry Jameson 819cd41cf0 Merge remote-tracking branch 'origin/develop' into improve_settings_reusability
* origin/develop:
  Translated using Weblate (Chinese (Simplified))
  Generalize IntegerSetting into NumberSetting, add Integer/Float wrappers
  Allow custom emoji reactions: add option to scale reaction buttons
  Fix user-profile route crash on pinned favorites route
  Hide custom emoji in reaction picker when BE does not advertise pleroma_custom_emoji_reactions
  Allow custom emoji reactions
2023-03-20 22:48:38 +02:00
.gitlab label, info on WIPs 2022-07-31 17:07:07 +03:00
build Use stylelint 2023-01-09 13:02:16 -05:00
config Fix phoenix sockets in dev mode 2022-04-06 18:52:16 -04:00
docs Update doc on making and using custom builds. 2023-01-19 00:26:24 +02:00
src Merge remote-tracking branch 'origin/develop' into improve_settings_reusability 2023-03-20 22:48:38 +02:00
static Generate grouped unicode emojis from unicode-emoji-json 2022-09-18 13:19:53 -04:00
test Fix unit tests 2023-01-21 22:42:53 -05:00
tools update emoji.json, add script that merges new emoji from another source 2020-11-30 14:43:39 +02:00
.babelrc Make chunks named 2022-09-20 23:13:07 -04:00
.editorconfig Basic skeleton 2016-10-26 16:46:32 +02:00
.eslintignore Basic skeleton 2016-10-26 16:46:32 +02:00
.eslintrc.js disable vue rule 2022-07-31 12:24:06 +03:00
.gitignore Generate grouped unicode emojis from unicode-emoji-json 2022-09-18 13:19:53 -04:00
.gitlab-ci.yml Use node 16 2022-07-18 03:48:11 +00:00
.mailmap Add myself to .mailmap 2021-02-15 13:17:52 +03:00
.node-version Update Node.js to v16.18.1 2022-11-06 09:03:30 +00:00
.stylelintrc.json Disable no-shorthand for certain props for better readability 2023-01-13 00:37:42 -05:00
BREAKING_CHANGES.md fixup! Removed formattingOptionsEnabled in favor of relying on BE-provided list of accepted formatting options 2019-06-16 20:23:07 +03:00
CHANGELOG.md Add changelog for 2.5.1 2023-02-10 23:58:38 -05:00
COFE_OF_CONDUCT.md Update COFE_OF_CONDUCT.md 2017-02-19 10:08:57 -05:00
CONTRIBUTORS.md Normalize tusooa's name 2022-12-19 14:50:42 +00:00
LICENSE Add license 2016-11-22 12:15:05 -05:00
README.md less John Paul "Scatman" Larkin content in the screenshot 2022-12-22 14:41:36 +00:00
image-1.png less John Paul "Scatman" Larkin content in the screenshot 2022-12-22 14:41:36 +00:00
image.png Update README.md, image.png 2022-12-22 14:27:05 +00:00
index.html Use correct html syntax for modal <div> 2023-01-20 23:40:11 -05:00
package.json Merge branch 'renovate/babel-monorepo' into 'develop' 2023-03-03 01:41:14 +00:00
postcss.config.js revives autoprefixer which went AWOL during Webpack v1 -> v4 migration 2019-08-14 01:18:07 +03:00
renovate.json Add renovate.json 2022-03-06 17:50:32 +00:00
yarn.lock Merge branch 'renovate/babel-monorepo' into 'develop' 2023-03-03 01:41:14 +00:00

README.md

Pleroma-FE

Highly-customizable frontend designed for Pleroma.

screenshot

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/ folder and added in a list within 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 and in case you want to build your own custom version there's another

Build Setup

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