update readme and dependencies
Some checks failed
Some checks failed
This commit is contained in:
39
README.md
39
README.md
@ -1,12 +1,6 @@
|
|||||||
# `pl-fe`
|
# `ncd-fe`
|
||||||
|
|
||||||
[](https://codeberg.org/mkljczk/pl-fe)
|
`ncd-fe` is a social networking client app. It works with any Mastodon API-compatible software, but it's focused on supporting alternative backends, like Pleroma or GoToSocial.
|
||||||
[](https://github.com/mkljczk/pl-fe)
|
|
||||||
[](https://github.com/mkljczk/pl-fe?tab=AGPL-3.0-1-ov-file#readme)
|
|
||||||
[](https://hosted.weblate.org/engage/pl-fe/)
|
|
||||||

|
|
||||||
|
|
||||||
`pl-fe` is a social networking client app. It works with any Mastodon API-compatible software, but it's focused on supporting alternative backends, like Pleroma or GoToSocial.
|
|
||||||
|
|
||||||
## Goals
|
## Goals
|
||||||
|
|
||||||
@ -15,12 +9,6 @@
|
|||||||
- **Unopinionated**: `pl-fe` doesn't impose any arbitrary limitations on the user. We do not specify a limit of reactions you can use on a single post and try to implement every feature available in the API.
|
- **Unopinionated**: `pl-fe` doesn't impose any arbitrary limitations on the user. We do not specify a limit of reactions you can use on a single post and try to implement every feature available in the API.
|
||||||
- **Stay private**: `pl-fe` includes features which help you maintain online privacy. This includes URL cleaning, which helps you remove unwanted parts of URLs used to mark your online activity.
|
- **Stay private**: `pl-fe` includes features which help you maintain online privacy. This includes URL cleaning, which helps you remove unwanted parts of URLs used to mark your online activity.
|
||||||
|
|
||||||
## Try it out
|
|
||||||
|
|
||||||
Want to test `pl-fe` with **any existing MastoAPI-compatible server?** Try [pl.mkljczk.pl](https://pl.mkljczk.pl) — enter your server's domain name to use `pl-fe` on any server!
|
|
||||||
|
|
||||||
If you want to use `pl-fe` on your server, follow the installation instructions in the documentation. We offer guides for [Pleroma/Akkoma](https://pl.mkljczk.pl/docs/installing/pleroma/), [Iceshrimp.NET](https://pl.mkljczk.pl/docs/installing/iceshrimp/), [Mitra](https://pl.mkljczk.pl/docs/installing/mitra/), and [standalone installations](https://pl.mkljczk.pl/docs/installing/standalone/).
|
|
||||||
|
|
||||||
## Repository
|
## Repository
|
||||||
|
|
||||||
The repository hosts `pl-fe`, but also libraries related to the project. Currently, this includes:
|
The repository hosts `pl-fe`, but also libraries related to the project. Currently, this includes:
|
||||||
@ -29,25 +17,9 @@ The repository hosts `pl-fe`, but also libraries related to the project. Current
|
|||||||
- [pl-api](./packages/pl-api) — a library for interacting with Mastodon API-compatible servers, focused on support for projects extending the official Mastodon API. It is used by `pl-fe`.
|
- [pl-api](./packages/pl-api) — a library for interacting with Mastodon API-compatible servers, focused on support for projects extending the official Mastodon API. It is used by `pl-fe`.
|
||||||
- [pl-hooks](./packages/pl-hooks) — a library including hooks for integrating with Mastodon API, based on `pl-api` and TanStack Query. It is intended to be used within `pl-fe`. Work in progress.
|
- [pl-hooks](./packages/pl-hooks) — a library including hooks for integrating with Mastodon API, based on `pl-api` and TanStack Query. It is intended to be used within `pl-fe`. Work in progress.
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
This project is hosted on [Codeberg](https://codeberg.org/mkljczk/pl-fe) and [GitHub](https://github.com/mkljczk/pl-fe). You can open issues on Codeberg or create pull requests on both platforms.
|
|
||||||
|
|
||||||
You can find more information about setting up the development environment in [the documentation](https://pl.mkljczk.pl/docs/contributing/pl-fe/).
|
|
||||||
|
|
||||||
## FAQ / Common misconceptions
|
|
||||||
|
|
||||||
### What does the project name mean?
|
|
||||||
|
|
||||||
I named the project after my now-deprecated personal fork of Pleroma, called simply `pl`. They were meant to be recommended together. However, `pl-fe` evolved into something more serious than a little fork. This is a bad and confusing name, but I don't really care about branding.
|
|
||||||
|
|
||||||
> For a maintained fork of Pleroma focused on `pl-fe` compatibility, check out my new project, [Nicolex](https://codeberg.org/mkljczk/nicolex).
|
|
||||||
|
|
||||||
I will bite people calling `pl-fe` *Polish front-end* or *Polish Soapbox*. And I don't mean sending them the [`Bite` activity](https://ns.mia.jetzt/as/) (which works in pl-fe on supported backends btw).
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
`pl-fe` is a fork of [Soapbox](https://gitlab.com/soapbox-pub/soapbox/) and inherits a lot of code from [Mastodon](https://github.com/mastodon/mastodon/).
|
`ncd-fe` is a fork of [mkljczk's pl-fe](https://codeberg.org/mkljczk/pl-fe) and inherits a lot of code from [Mastodon](https://github.com/mastodon/mastodon/).
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
This program is free software: you can redistribute it and/or modify
|
||||||
it under the terms of the GNU Affero General Public License as published by
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
@ -63,8 +35,3 @@ You should have received a copy of the GNU Affero General Public License
|
|||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow [my Pleroma account](https://pl.fediverse.pl/@mkljczk) to stay up to date on `pl-fe` development.
|
|
||||||
|
|
||||||
|
|
||||||
This project is tested with BrowserStack.
|
|
||||||
|
|||||||
@ -14,5 +14,6 @@
|
|||||||
"glob-parent": "^6.0.1",
|
"glob-parent": "^6.0.1",
|
||||||
"jsonwebtoken": "^9.0.0",
|
"jsonwebtoken": "^9.0.0",
|
||||||
"loader-utils": "^2.0.3"
|
"loader-utils": "^2.0.3"
|
||||||
}
|
},
|
||||||
|
"packageManager": "pnpm@10.28.0+sha512.05df71d1421f21399e053fde567cea34d446fa02c76571441bfc1c7956e98e363088982d940465fd34480d4d90a0668bc12362f8aa88000a64e83d0b0e47be48"
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user