41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
# Akkoma-FE: Whimsical Forest Edition
|
||
|
||
This is [upstream Akkoma-FE `develop`](https://akkoma.dev/AkkomaGang/akkoma-fe/src/branch/develop)
|
||
with some additional patches for testing and/or convenience.
|
||
*(This will likely be less numerous and more conservative than the backend patches).
|
||
|
||
All patches (sans the initial wf-ifying one) are intended to reach upstream
|
||
eventually and either already have an upstream PR or are intended to be turned
|
||
into one once they’ve passed initial testing and became more stable.
|
||
|
||
See `patches/series` for a list of applied changes.
|
||
Patch names beginning with `pr111_` indicate it’s copied from upstream PR `#111`;
|
||
`wip_` is used for patches not yet ready for an upstream PR.
|
||
|
||
If the pr number is suffixed with `-e`, the patch was in some form altered
|
||
beyond resolving trivial merge conflicts and/or dropping changelog entries
|
||
*(a common source of merge conflicts)*. Details about the changes can be found
|
||
in the patch decription.
|
||
|
||
## Usage
|
||
|
||
You’re free to use this for your own instance but keep in mind some of those
|
||
patches are experimental and might not yet have been merged for a good reason.
|
||
Thus you should only do this if you’re comfortable with doing beta testing and
|
||
capable of debugging upcoming issues on your own far enought to figure out
|
||
which patch introduces the problem and create a useful, detailed report for
|
||
the corresponding upstream PR.
|
||
If a patch changes its database scheme prior to being merged upstream,
|
||
some manual DB fixups might be needed.
|
||
|
||
|
||
If you still want to, just clone this repo and run:
|
||
|
||
```sh
|
||
# build
|
||
make dist
|
||
# install (alternatively just copy the dist folder)
|
||
wffdir="$PWD"
|
||
cd /akkoma/backend/dir
|
||
MIX_ENV=prod mix pleroma.frontend install pleroma-fe --file "$wffdir"/akkoma-fe/dist --ref develop
|
||
```
|