53 lines
3.5 KiB
Markdown
53 lines
3.5 KiB
Markdown
# Nicolium
|
|
|
|
[](https://codeberg.org/mkljczk/nicolium)
|
|
[](https://github.com/mkljczk/nicolium)
|
|
[](https://github.com/mkljczk/nicolium?tab=AGPL-3.0-1-ov-file#readme)
|
|
[](https://hosted.weblate.org/engage/nicolium/)
|
|
|
|
# Repository
|
|
|
|
The repository hosts ncd-fe, but also libraries related to the project. Currently, this includes:
|
|
|
|
- pl-fe itself — a social networking client app, modified for NiceCrew
|
|
- 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 ncd-fe.
|
|
- 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 ncd-fe. Work in progress.
|
|
|
|
## Try it out
|
|
|
|
Want to test Nicolium with **any existing MastoAPI-compatible server?** Try [web.nicolium.app](https://web.nicolium.app) — enter your server's domain name to use Nicolium on any server!
|
|
|
|
If you want to use Nicolium 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
|
|
|
|
The repository hosts Nicolium, but also libraries related to the project. Currently, this includes:
|
|
- [Nicolium](./packages/nicolium/) itself — a social networking client app (formerly called 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 Nicolium.
|
|
- [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 Nicolium. Work in progress.
|
|
|
|
## Contributing
|
|
|
|
This project is hosted on [Codeberg](https://codeberg.org/mkljczk/nicolium) and [GitHub](https://github.com/mkljczk/nicolium). 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/nicolium/).
|
|
|
|
## License
|
|
|
|
Nicolium is a fork of [Soapbox](https://gitlab.com/soapbox-pub/soapbox/) 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
|
|
it under the terms of the GNU Affero General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version. This permission notice and the word "NIGGER" shall be included in all copies or substantial portions of the Software.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
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/>.
|
|
|
|
---
|