@ -1,8 +1,8 @@
|
||||
# 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://codeberg.org/nicolium/nicolium)
|
||||
[](https://github.com/nicolium/nicolium)
|
||||
[](https://github.com/nicolium/nicolium?tab=AGPL-3.0-1-ov-file#readme)
|
||||
[](https://hosted.weblate.org/engage/nicolium/)
|
||||

|
||||
|
||||
@ -30,7 +30,7 @@ The repository hosts Nicolium, but also libraries related to the project. Curren
|
||||
|
||||
## 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.
|
||||
This project is hosted on [Codeberg](https://codeberg.org/nicolium/nicolium) and [GitHub](https://github.com/nicolium/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://nicolium.app/docs/contributing/nicolium/).
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ You can now proceed to fetching Nicolium Git repository, installing dependencies
|
||||
|
||||
```bash
|
||||
# Clone the Nicolium repository
|
||||
git clone https://codeberg.org/mkljczk/nicolium.git
|
||||
git clone https://codeberg.org/nicolium/nicoliumm.git
|
||||
cd nicolium
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
@ -29,7 +29,7 @@ You can now proceed to fetching Nicolium Git repository, installing dependencies
|
||||
|
||||
```bash
|
||||
# Clone the Nicolium repository
|
||||
git clone https://codeberg.org/mkljczk/nicolium.git
|
||||
git clone https://codeberg.org/nicolium/nicoliumm.git
|
||||
cd nicolium
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
@ -60,7 +60,7 @@ pnpm -F nicolium test:watch
|
||||
|
||||
## Contributing guidelines
|
||||
|
||||
Nicolium hosts its repository on [Codeberg](https://codeberg.org/mkljczk/nicolium) and [GitHub](https://github.com/mkljczk/nicolium). While issues are only tracked on Codeberg, you can submit pull requests on both platforms. Remember to follow the [Code of Conduct](./code-of-conduct.mdx) when interacting with the community.
|
||||
Nicolium hosts its repository on [Codeberg](https://codeberg.org/nicolium/nicoliumm) and [GitHub](https://github.comnicolium/nicoliumum). While issues are only tracked on Codeberg, you can submit pull requests on both platforms. Remember to follow the [Code of Conduct](./code-of-conduct.mdx) when interacting with the community.
|
||||
The project uses [ESLint](https://eslint.org/) and [Stylelint](https://stylelint.io/) for code style checking, which is automatically run on every commit using [Husky](https://typicode.github.io/husky). You can run the linters manually using the following command:
|
||||
|
||||
```bash
|
||||
|
||||
@ -25,7 +25,7 @@ You can now proceed to fetching Nicolium Git repository, installing dependencies
|
||||
|
||||
```bash
|
||||
# Clone the Nicolium repository
|
||||
git clone https://codeberg.org/mkljczk/nicolium.git
|
||||
git clone https://codeberg.org/nicolium/nicoliumm.git
|
||||
cd nicolium
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
@ -37,7 +37,7 @@ This will start a Vite development server where you can use `pl-api` client insi
|
||||
|
||||
## Contributing guidelines
|
||||
|
||||
Nicolium monorepo is hosted on [Codeberg](https://codeberg.org/mkljczk/nicolium) and [GitHub](https://github.com/mkljczk/nicolium). While issues are only tracked on Codeberg, you can submit pull requests on both platforms. Remember to follow the [Code of Conduct](./code-of-conduct.mdx) when interacting with the community.
|
||||
Nicolium monorepo is hosted on [Codeberg](https://codeberg.org/nicolium/nicoliumm) and [GitHub](https://github.comnicolium/nicoliumum). While issues are only tracked on Codeberg, you can submit pull requests on both platforms. Remember to follow the [Code of Conduct](./code-of-conduct.mdx) when interacting with the community.
|
||||
|
||||
The project uses [ESLint](https://eslint.org/) for code style checking. You can run the linter using the following command:
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ Changes made since the project forked from Soapbox in April 2024.
|
||||
|
||||
### Major changes
|
||||
|
||||
- Switched to a separate library [`pl-api`](https://codeberg.org/mkljczk/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/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.
|
||||
|
||||
### Added
|
||||
|
||||
|
||||
@ -2,6 +2,6 @@
|
||||
"name": "Nicolium",
|
||||
"description": "Mastodon-compatible social media front-end.",
|
||||
"keywords": ["fediverse"],
|
||||
"website": "https://codeberg.org/mkljczk/nicolium",
|
||||
"website": "https://codeberg.org/nicolium/nicolium",
|
||||
"stack": "container"
|
||||
}
|
||||
|
||||
@ -7,14 +7,14 @@
|
||||
"fediverse",
|
||||
"pleroma"
|
||||
],
|
||||
"homepage": "https://codeberg.org/mkljczk/nicolium",
|
||||
"homepage": "https://codeberg.org/nicolium/nicolium",
|
||||
"bugs": {
|
||||
"url": "https://codeberg.org/mkljczk/nicolium/issues"
|
||||
"url": "https://codeberg.org/nicolium/nicolium/issues"
|
||||
},
|
||||
"license": "AGPL-3.0-or-later",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://codeberg.org/mkljczk/nicolium"
|
||||
"url": "https://codeberg.org/nicolium/nicolium"
|
||||
},
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
<p>Nicolium is free and open source (FOSS) software.</p>
|
||||
<p>
|
||||
The Nicolium repository can be found at
|
||||
<a href="https://codeberg.org/mkljczk/nicolium" target="_blank" rel="noopener noreferrer"
|
||||
<a href="https://codeberg.org/nicolium/nicolium" target="_blank" rel="noopener noreferrer"
|
||||
>Codeberg</a
|
||||
>
|
||||
</p>
|
||||
|
||||
@ -172,7 +172,7 @@ const CreateAppPage: React.FC = () => {
|
||||
>
|
||||
<Input
|
||||
type='text'
|
||||
placeholder='https://codeberg.org/mkljczk/nicolium'
|
||||
placeholder='https://codeberg.org/nicolium/nicolium'
|
||||
onChange={handleParamChange('website')}
|
||||
value={params.website}
|
||||
/>
|
||||
@ -185,7 +185,7 @@ const CreateAppPage: React.FC = () => {
|
||||
>
|
||||
<Input
|
||||
type='text'
|
||||
placeholder='https://codeberg.org/mkljczk/nicolium'
|
||||
placeholder='https://codeberg.org/nicolium/nicolium'
|
||||
onChange={handleParamChange('redirect_uris')}
|
||||
value={params.redirect_uris}
|
||||
required
|
||||
|
||||
@ -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/mkljczk/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/mkljczk/nicolium/src/branch/develop/packages/pl-hooks) is a work-in-progress library utilizing `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`.
|
||||
|
||||
If you are using `pl-api` in your project, please open a pull request with a link to the project.
|
||||
|
||||
|
||||
@ -8,7 +8,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/mkljczk/nicolium/src/branch/develop/packages/pl-api
|
||||
- Homepage: https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-api
|
||||
- Documentation: https://pl.mkljczk.pl/pl-api-docs
|
||||
- NPM package: https://www.npmjs.com/package/pl-api
|
||||
|
||||
@ -95,8 +95,8 @@ page1.items.forEach(account => console.log(account.username));
|
||||
|
||||
## Projects using pl-api
|
||||
|
||||
- Nicolium - Web client for Mastodon-compatible servers (https://codeberg.org/mkljczk/nicolium)
|
||||
- **pl-hooks** - React hooks library for Mastodon APIs (https://codeberg.org/mkljczk/nicolium/src/branch/develop/packages/pl-hooks)
|
||||
- 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)
|
||||
|
||||
## Development
|
||||
|
||||
@ -159,8 +159,8 @@ stream.listen((event) => {
|
||||
|
||||
## Links
|
||||
|
||||
- Repository: https://codeberg.org/mkljczk/nicolium
|
||||
- Issues: https://codeberg.org/mkljczk/nicolium/issues
|
||||
- Repository: https://codeberg.org/nicolium/nicolium
|
||||
- Issues: https://codeberg.org/nicolium/nicolium/issues
|
||||
- NPM package: https://www.npmjs.com/package/pl-api
|
||||
- API documentation: https://pl.mkljczk.pl/pl-api-docs
|
||||
- Mastodon API docs: https://docs.joinmastodon.org
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
{
|
||||
"name": "pl-api",
|
||||
"version": "1.0.0-rc.99",
|
||||
"homepage": "https://codeberg.org/mkljczk/nicolium/src/branch/develop/packages/pl-api",
|
||||
"homepage": "https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-api",
|
||||
"bugs": {
|
||||
"url": "https://codeberg.org/mkljczk/nicolium/issues"
|
||||
"url": "https://codeberg.org/nicolium/nicolium/issues"
|
||||
},
|
||||
"license": "AGPL-3.0-or-later",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://codeberg.org/mkljczk/nicolium.git"
|
||||
"url": "git+https://codeberg.org/nicolium/nicolium.git"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
{
|
||||
"name": "pl-hooks",
|
||||
"version": "0.0.15",
|
||||
"homepage": "https://codeberg.org/mkljczk/nicolium/src/branch/develop/packages/pl-hooks",
|
||||
"homepage": "https://codeberg.org/nicolium/nicolium/src/branch/develop/packages/pl-hooks",
|
||||
"bugs": {
|
||||
"url": "https://codeberg.org/mkljczk/nicolium/issues"
|
||||
"url": "https://codeberg.org/nicolium/nicolium/issues"
|
||||
},
|
||||
"license": "AGPL-3.0-or-later",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://codeberg.org/mkljczk/nicolium"
|
||||
"url": "https://codeberg.org/nicolium/nicolium"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
|
||||
@ -4,11 +4,11 @@
|
||||
"version": "0.0.1",
|
||||
"homepage": "https://nicolium.app",
|
||||
"bugs": {
|
||||
"url": "https://codeberg.org/mkljczk/nicolium/issues"
|
||||
"url": "https://codeberg.org/nicolium/nicolium/issues"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://codeberg.org/mkljczk/nicolium.git"
|
||||
"url": "git+https://codeberg.org/nicolium/nicolium.git"
|
||||
},
|
||||
"scripts": {
|
||||
"dev": "astro dev",
|
||||
|
||||
@ -8,7 +8,7 @@ const footerLinks = [
|
||||
},
|
||||
{
|
||||
label: "Source code",
|
||||
href: "https://codeberg.org/mkljczk/nicolium",
|
||||
href: "https://codeberg.org/nicolium/nicolium",
|
||||
target: "_blank",
|
||||
},
|
||||
];
|
||||
|
||||
@ -18,7 +18,7 @@ const navItems = [
|
||||
},
|
||||
{
|
||||
label: "Source code",
|
||||
href: "https://codeberg.org/mkljczk/nicolium",
|
||||
href: "https://codeberg.org/nicolium/nicolium",
|
||||
target: "_blank",
|
||||
},
|
||||
];
|
||||
|
||||
@ -30,7 +30,7 @@ import Screenshot6 from "../assets/screenshot6.png";
|
||||
buttonLink="https://web.nicolium.app"
|
||||
buttonTarget="_blank"
|
||||
button2Text="Source code"
|
||||
button2Link="https://codeberg.org/mkljczk/nicolium"
|
||||
button2Link="https://codeberg.org/nicolium/nicolium"
|
||||
button2Target="_blank"
|
||||
/>
|
||||
<section class="sections">
|
||||
@ -67,10 +67,10 @@ import Screenshot6 from "../assets/screenshot6.png";
|
||||
heading="Open source."
|
||||
subheading="Nicolium is free and open source software. You can participate in development, contribute to the project or report bugs."
|
||||
buttonText="Codeberg"
|
||||
buttonLink="https://codeberg.org/mkljczk/nicolium"
|
||||
buttonLink="https://codeberg.org/nicolium/nicolium"
|
||||
buttonTarget="_blank"
|
||||
button2Text="GitHub"
|
||||
button2Link="https://github.com/mkljczk/nicolium"
|
||||
button2Link="https://github.com/nicolium/nicolium"
|
||||
button2Target="_blank"
|
||||
imageSrc={Screenshot6}
|
||||
imageAlt="Screenshot of a part of pl-api source code"
|
||||
|
||||
Reference in New Issue
Block a user