update docs

Signed-off-by: nicole mikołajczyk <git@mkljczk.pl>
This commit is contained in:
nicole mikołajczyk
2026-03-22 17:46:32 +01:00
parent 31ae3d1866
commit 3c0a4d0f87
8 changed files with 13 additions and 13 deletions

View File

@ -9,7 +9,7 @@ order: 31
Installing Nicolium as a frontend for Mitra is no different from installing the default Mitra Web frontend. Just extract the Nicolium files into the directory specified in `config.yaml` under `web_client_dir`, by default `/usr/share/mitra/www`.
```bash
curl -O https://pl.mkljczk.pl/pl-fe.zip
curl -O https://web.nicolium.app/release.zip
unzip pl-fe.zip -d /usr/share/mitra/www
rm pl-fe.zip
```

View File

@ -11,7 +11,7 @@ order: 32
The most straightforward way to install Nicolium as a frontend for Pleroma or Akkoma is to simply download it and place its files in the `/instance/static` directory of your Pleroma/Akkoma installation (usually `/opt/pleroma/instance/static` or `/opt/akkoma/instance/static`, accordingly).
```bash
curl -O https://pl.mkljczk.pl/pl-fe.zip
curl -O https://web.nicolium.app/release.zip
unzip pl-fe.zip -d /opt/pleroma/instance/static/
rm pl-fe.zip
```
@ -24,13 +24,13 @@ To install it from CLI, use:
### OTP
```bash
./bin/pleroma_ctl frontend install pl-fe --ref develop --build-url https://pl.mkljczk.pl/pl-fe.zip --build-dir .
./bin/pleroma_ctl frontend install pl-fe --ref release --build-url https://web.nicolium.app/release.zip --build-dir .
```
### From Source
```bash
mix pleroma.frontend install pl-fe --ref develop --build-url https://pl.mkljczk.pl/pl-fe.zip --build-dir .
mix pleroma.frontend install pl-fe --ref release --build-url https://web.nicolium.app/release.zip --build-dir .
```
It is now possible to set Nicolium as the primary frontend in the configuration file or via AdminFE:
@ -38,7 +38,7 @@ It is now possible to set Nicolium as the primary frontend in the configuration
config :pleroma, :frontends,
primary: %{
"name" => "pl-fe",
"ref" => "develop"
"ref" => "release"
},
...
```

View File

@ -19,4 +19,4 @@ nicolium.example.com {
}
```
This assumes you're serving Nicolium under the nicolium.example.com domain and the Nicolium files are located in `/var/www/nicolium`. You can download Nicolium from `https://pl.mkljczk.pl/pl-fe.zip` or [build it from source](../building/nicolium.md).
This assumes you're serving Nicolium under the nicolium.example.com domain and the Nicolium files are located in `/var/www/nicolium`. You can download Nicolium from `https://web.nicolium.app/release.zip` or [build it from source](../building/nicolium.md).

View File

@ -6,7 +6,7 @@
### Major changes
- Switched to a separate library [`pl-api`](https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-api) for Mastodon API integration. It is mostly written from scratch, inheriting minor code parts from Soapbox/Mastodon. This also comes with improved compatibility with various Mastodon API extensions and abstracts out the implementation details.
- Switched to a separate library [`pl-api`](https://codeberg.org/nicolium/nicolium/src/packages/pl-api) for Mastodon API integration. It is mostly written from scratch, inheriting minor code parts from Soapbox/Mastodon. This also comes with improved compatibility with various Mastodon API extensions and abstracts out the implementation details.
- Migrated client data stores from Redux to Zustand and remote data stores to TanStack Query. Stores have been migrated away from `immutable`.
- Migrated router from React Router to TanStack Router.
- Styles are being migrated from TailwindCSS to SCSS.

View File

@ -38,8 +38,8 @@ For unsupported projects, it falls back to a basic feature set, though every met
## Projects using `pl-api`
- [Nicolium](https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/nicolium) is a web client for Mastodon-compatible servers forked from Soapbox. It uses `pl-api` for API interactions.
- [`pl-hooks`](https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-hooks) is a work-in-progress library utilizing `pl-api`.
- [Nicolium](https://codeberg.org/nicolium/nicolium/src/packages/nicolium) is a web client for Mastodon-compatible servers forked from Soapbox. It uses `pl-api` for API interactions.
- [`pl-hooks`](https://codeberg.org/nicolium/nicolium/src/packages/pl-hooks) is a work-in-progress library utilizing `pl-api`.
If you are using `pl-api` in your project, please open a pull request with a link to the project.

View File

@ -10,7 +10,7 @@ pl-api is a TypeScript/JavaScript library that provides a type-safe client for i
- Version: 1.0.0-rc.94
- License: AGPL-3.0-or-later
- Homepage: https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-api
- Homepage: https://codeberg.org/nicolium/nicolium/src/packages/pl-api
- Documentation: https://pl.mkljczk.pl/pl-api-docs
- NPM package: https://www.npmjs.com/package/pl-api
@ -98,7 +98,7 @@ page1.items.forEach(account => console.log(account.username));
## Projects using pl-api
- Nicolium - Web client for Mastodon-compatible servers (https://codeberg.org/nicolium/nicolium)
- **pl-hooks** - React hooks library for Mastodon APIs (https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-hooks)
- **pl-hooks** - React hooks library for Mastodon APIs (https://codeberg.org/nicolium/nicolium/src/packages/pl-hooks)
## Development

View File

@ -1,7 +1,7 @@
{
"name": "pl-api",
"version": "1.0.0-rc.99",
"homepage": "https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-api",
"homepage": "https://codeberg.org/nicolium/nicolium/src/packages/pl-api",
"bugs": {
"url": "https://codeberg.org/nicolium/nicolium/issues"
},

View File

@ -1,7 +1,7 @@
{
"name": "pl-hooks",
"version": "0.0.15",
"homepage": "https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-hooks",
"homepage": "https://codeberg.org/nicolium/nicolium/src/packages/pl-hooks",
"bugs": {
"url": "https://codeberg.org/nicolium/nicolium/issues"
},