klafbang/nicolium
Watch
1
0
Fork
You've already forked nicolium
 0
forked from mirrors/nicolium
Code Pull requests Activity Actions 2
Mastodon API-compatible social media front-end
16,320 commits 5 branches 9 tags 73 MiB
  • TypeScript 89.5%
  • SCSS 8.8%
  • MDX 0.7%
  • HTML 0.3%
  • CSS 0.3%
  • Other 0.3%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Michael Westergaard d193a061c8
Some checks failed
pl-api CI / Test for pl-api formatting (push) Successful in 54s
Details
Nicolium CI / Check if the code builds and is formatted correctly (push) Failing after 1m8s
Details
Fix last update warnings
2026-09-12 08:29:10 +02:00
.devcontainer make devcontainer work with podman hope it doesn't break docker but that's not really important 2026-06-02 09:09:59 +00:00
.forgejo/workflows Disable slow cache 2026-09-10 00:03:39 +02:00
.github restore release workflow 2026-08-26 15:27:55 +00:00
.husky run precommit recursively 2026-07-27 14:53:01 +00:00
.vscode update vscode settings 2026-09-02 18:31:40 +00:00
docs update docs 2026-08-25 18:28:07 +00:00
packages Fix last update warnings 2026-09-12 08:29:10 +02:00
patches Remove some build warnings 2026-09-11 08:37:11 +02:00
.editorconfig cleanup 2026-07-27 14:55:12 +00:00
.gitignore just so i don't accidentally commit too much 2026-07-21 12:13:36 +00:00
.npmrc Add ignore-scripts to .npmrc 2026-03-31 14:08:37 +02:00
.tool-versions add missing file 2026-07-26 14:59:25 +00:00
CHANGELOG.md add CONTRIBUTING.md symlink, fix CHANGELOG.md symlink 2026-04-09 22:12:49 +00:00
LICENSE Add license to main directory 2024-09-15 23:48:43 +02:00
package.json Remove some build warnings 2026-09-11 08:37:11 +02:00
pnpm-lock.yaml Fix last update warnings 2026-09-12 08:29:10 +02:00
pnpm-workspace.yaml Fix last update warnings 2026-09-12 08:29:10 +02:00
README.md Update README.md 2026-09-10 10:14:51 +00:00

README.md

Nicolium

Nicolium 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

  • Feature-rich: Nicolium includes a wide range of features, such as a WYSIWYG text editor, draft posts, and more.
  • Compatibility: Nicolium is compatible with any Mastodon API-compatible software, treating alternative backends as first-class citizens. Chats, emoji reactions, groups, interaction policies? We support them all. Thanks to pl-api, which provides a unified interface for interacting with Mastodon API-compatible servers, implementation differences do not affect the user experience.
  • Unopinionated: Nicolium 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: Nicolium 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

If you want to use Nicolium on your server, follow the installation instructions in the documentation. We offer guides for Pleroma/Akkoma, Iceshrimp.NET, Mitra, and standalone installations.

Repository

The repository hosts Nicolium, but also libraries related to the project. Currently, this includes:

  • Nicolium itself — a social networking client app (formerly called pl-fe)
  • 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 — 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

You can find more information about setting up the development environment in the documentation.

License

Nicolium is a fork of Soapbox and inherits a lot of code from 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 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/.