- TypeScript 89.8%
- SCSS 8.8%
- MDX 0.5%
- HTML 0.3%
- CSS 0.3%
- Other 0.3%
|
|
||
|---|---|---|
| .devcontainer | ||
| .forgejo/workflows | ||
| .github | ||
| .husky | ||
| .vscode | ||
| docs | ||
| packages | ||
| .editorconfig | ||
| .gitignore | ||
| .npmrc | ||
| .tool-versions | ||
| AGENTS.md | ||
| CHANGELOG.md | ||
| CLAUDE.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| 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
Want to test Nicolium with any existing MastoAPI-compatible server? Try 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, 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-apiand TanStack Query. It is intended to be used within Nicolium. Work in progress.
Contributing
This project is hosted on git.pleroma.social, Codeberg and GitHub. You can open issues and create pull requests on git.pleroma.social.
You can find more information about setting up the development environment in the documentation.
Sponsors
If you want to support the project, consider sponsoring mkljczk or pmysl on GitHub Sponsors or donating to mkljczk via Monero: 8C9cVFPycccYt4EejmyqZhQRPSEUSi1Ht9MQL4gdBjsX5f2TvSHP8i5AS4PWCnKM9wW7UUFVAGiY1LhNoQZfJan8Lse6Ct7.
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/.
Follow my Pleroma account to stay up to date on Nicolium development.
This project is tested with BrowserStack.