A fork of AkkomaGang/akkoma-fe
Go to file
itepechi 37a6f2be7b Shorten version name
'akkoma 3.10.0-akkoma+bnakkoma' is unnecessarily long
2023-09-28 06:20:04 +09:00
.gitea/issue_template Add YAML bug and feat templates 2022-12-08 20:24:21 +02:00
build Fix build 2022-11-20 22:26:16 +00:00
config Add logo files 2022-12-02 11:27:24 +00:00
docs update more images 2023-05-26 23:02:38 -04:00
src Merge remote-tracking branch 'upstream/develop' into bnakkoma 2023-09-27 06:45:50 +09:00
static Improve support for favicon and PWA icons 2023-09-26 08:56:32 +09:00
test Big 'ol set of patches and dep maintenance (#212) 2022-11-15 15:47:32 +00:00
tools update emoji.json, add script that merges new emoji from another source 2020-11-30 14:43:39 +02:00
.babelrc cleanup 2022-03-23 15:44:37 +02:00
.dockerignore Add a Makefile for easy building 2023-08-01 23:41:41 +09: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 Big 'ol set of patches and dep maintenance (#212) 2022-11-15 15:47:32 +00:00
.gitignore Add a Makefile for easy building 2023-08-01 23:41:41 +09:00
.mailmap Add myself to .mailmap 2021-02-15 13:17:52 +03:00
.node-version Add .node-version 2017-02-16 12:51:08 +01:00
.stylelintrc.json Only reload user if it _is_ a user (#232) 2022-11-22 14:40:25 +00:00
.woodpecker.yml don't die on my arm box please 2023-08-05 14:17:42 +01: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 Move remote interaction chnagelog entry to "Unreleased" 2022-09-19 18:39:36 -04:00
CODE_OF_CONDUCT.md Big 'ol set of patches and dep maintenance (#212) 2022-11-15 15:47:32 +00:00
CONTRIBUTORS.md editing (#158) 2022-09-06 19:25:03 +00:00
Dockerfile Add a Makefile for easy building 2023-08-01 23:41:41 +09:00
LICENSE Add license 2016-11-22 12:15:05 -05:00
Makefile Allow changing NODE_ENV 2023-09-16 07:15:14 +09:00
README.md Update README 2023-09-27 05:30:00 +09:00
index.html Improve support for favicon and PWA icons 2023-09-26 08:56:32 +09:00
package.json Shorten version name 2023-09-28 06:20:04 +09: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 Upgrade FontAwesome packages 2023-09-19 06:04:29 +09:00

README.md

BNAkkoma: Brand New Akkoma

It's not that new. This is just a cheap pun on the title of a furry anime.

What is this?

This is a fork of AkkomaGang/akkoma-fe, with a custom theme and Makefile.

The differences from the upstream repository are described below:

  • Added a Makefile where you can build the client inside a Docker container
  • Refactored some components and styles
  • Added and changed the default theme to a custom one
  • Fixed the dimensions of some elements that appeared to be misaligned
  • Added support for setting the default post language
  • Stole some commits from the original Pleroma frontend
  • Added the Media tab to the search page (requires appropriate backend)
  • Added support to search for posts from people you follow (requires appropriate backend)
  • More than 200 (!) Japanese translations have been fixed
  • Removed some themes to save network bandwidth
  • Improved PWA support, sort of

How to build

Requires 2GB+ memory.

# Docker
make

# Podman
make RUNTIME=podman

Akkoma-FE

English OK 日本語OK

This is a fork of Akkoma-FE from the Pleroma project, with support for new Akkoma features such as:

  • MFM support via marked-mfm
  • Custom emoji reactions

For Translators

The Weblate UI is recommended for adding or modifying translations for Akkoma-FE.

Alternatively, edit/create src/i18n/$LANGUAGE_CODE.json (where $LANGUAGE_CODE is the ISO 639-1 code for your language), then add your language to src/i18n/messages.js if it doesn't already exist there.

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

FOR ADMINS

To use Akkoma-FE in Akkoma, use the frontend CLI task to install Akkoma-FE, then modify your configuration as described in the Frontend Management doc.

Build Setup

# install dependencies
npm install -g yarn
yarn

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

# build for production with minification
npm run build

# run unit tests
npm run 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

Edit config.json for configuration.

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.