diff --git a/.circleci/config.yml b/.circleci/config.yml index 64f523813..21c7ec3db 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -28,7 +28,7 @@ jobs: - run: working_directory: packages/nicolium name: Deploy to Vercel - command: vercel deploy --token $VERCEL_TOKEN --prod=false --confirm --name pl-fe + command: vercel deploy --token $VERCEL_TOKEN --prod=false --confirm --name nicolium workflows: deploy_on_pr: diff --git a/.forgejo/workflows/nicolium.yaml b/.forgejo/workflows/nicolium.yaml index 264f7f8d8..c05da0425 100644 --- a/.forgejo/workflows/nicolium.yaml +++ b/.forgejo/workflows/nicolium.yaml @@ -53,7 +53,7 @@ jobs: - name: Include archive working-directory: ./packages/nicolium/dist - run: zip -r ../pl-fe.zip . + run: zip -r ../nicolium.zip . - name: Build with landing page env: @@ -62,7 +62,7 @@ jobs: run: | WITH_LANDING_PAGE=true yarn build cp dist/index.html dist/404.html - cp pl-fe.zip dist/pl-fe.zip + cp nicolium.zip dist/pl-fe.zip - name: Install pl-api deps working-directory: ./packages/pl-api diff --git a/.github/workflows/nicolium.yaml b/.github/workflows/nicolium.yaml index ddb619c50..2b7867821 100644 --- a/.github/workflows/nicolium.yaml +++ b/.github/workflows/nicolium.yaml @@ -72,7 +72,7 @@ jobs: - name: Include archive working-directory: ./packages/nicolium/dist - run: zip -r ../pl-fe.zip . + run: zip -r ../nicolium.zip . - name: build env: @@ -81,7 +81,7 @@ jobs: run: | BANNER_HTML="pl.mkljczk.pl runs Nicolium's \`develop\` branch, which can break sometimes. For a more stable experience, use web.nicolium.app." WITH_LANDING_PAGE=true pnpm build cp dist/index.html dist/404.html - cp pl-fe.zip dist/pl-fe.zip + cp nicolium.zip dist/pl-fe.zip - name: Build pl-api documentation working-directory: ./packages/pl-api diff --git a/README.md b/README.md index ed3eba839..14c2f2cfa 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Nicolium (formerly `pl-fe`) +# Nicolium [![Codeberg Repo stars](https://img.shields.io/gitea/stars/mkljczk/nicolium?gitea_url=https%3A%2F%2Fcodeberg.org&logo=Codeberg)](https://codeberg.org/mkljczk/nicolium) [![GitHub Repo stars](https://img.shields.io/github/stars/mkljczk/nicolium)](https://github.com/mkljczk/nicolium) @@ -24,7 +24,7 @@ If you want to use Nicolium on your server, follow the installation instructions ## Repository The repository hosts Nicolium, but also libraries related to the project. Currently, this includes: -- [Nicolium](./packages/pl-fe/) itself — a social networking client app +- [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. @@ -34,16 +34,6 @@ This project is hosted on [Codeberg](https://codeberg.org/mkljczk/nicolium) and You can find more information about setting up the development environment in [the documentation](https://pl.mkljczk.pl/docs/contributing/nicolium/). -## ~~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 Nicolium 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 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/). diff --git a/docs/installing/iceshrimp.md b/docs/installing/iceshrimp.md index e9bc0b3d5..20d81c333 100644 --- a/docs/installing/iceshrimp.md +++ b/docs/installing/iceshrimp.md @@ -57,4 +57,4 @@ server { ## Example Caddy configuration -There is also a Caddyfile made by [Alexia](https://cyrneko.eu/) used by [The Starlight Network](https://shrimp.starlightnet.work/) instance. You can find it and read more about it [here](https://forge.starlightnet.work/Team/configurations/src/branch/master/pl-fe). +There is also a Caddyfile made by [Alexia](https://cyrneko.eu/) used by [The Starlight Network](https://shrimp.starlightnet.work/) instance. You can find it and read more about it [here](https://forge.starlightnet.work/Team/configurations/src/pl-fe). diff --git a/mkdocs.yml b/mkdocs.yml index 87c048a51..d2a04fc6f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: Nicolium (formerly pl-fe) Documentation +site_name: Nicolium Documentation site_url: https://pl.mkljczk.pl/docs/ theme: name: material diff --git a/packages/nicolium/src/locales/en.json b/packages/nicolium/src/locales/en.json index 11453dddb..e33de3e46 100644 --- a/packages/nicolium/src/locales/en.json +++ b/packages/nicolium/src/locales/en.json @@ -1315,7 +1315,7 @@ "landing.description": "Nicolium is a feature-rich Fediverse web client.", "landing.feature_rich.description": "Nicolium includes a lot features to improve your experience, like WYSIWYG text editor, draft posts and language detection.", "landing.feature_rich.title": "Feature-rich.", - "landing.logo": "Nicolium (formerly pl-fe)", + "landing.logo": "Nicolium", "landing.open_source.description": "Nicolium is free and open source software. You can participate in development, contribute to the project or report bugs.", "landing.open_source.title": "Open source.", "landing.pl_api.description": "Nicolium implements features not present in standard Mastodon API, like emoji reactions, chats or interaction policies.", diff --git a/packages/nicolium/src/pages/utils/landing.tsx b/packages/nicolium/src/pages/utils/landing.tsx index ad4447625..a960ce92c 100644 --- a/packages/nicolium/src/pages/utils/landing.tsx +++ b/packages/nicolium/src/pages/utils/landing.tsx @@ -17,7 +17,7 @@ const LandingPage = () => ( - => { tracesSampleRate: 0.1, }); - Sentry.setContext('pl-fe', sourceCode); + Sentry.setContext('nicolium', sourceCode); }; /** Associate the account with Sentry events. */ diff --git a/packages/nicolium/src/storage/kv-store.ts b/packages/nicolium/src/storage/kv-store.ts index ada9fe3d8..d7f866c81 100644 --- a/packages/nicolium/src/storage/kv-store.ts +++ b/packages/nicolium/src/storage/kv-store.ts @@ -8,7 +8,7 @@ interface IKVStore extends LocalForage { // https://localforage.github.io/localForage/#settings-api-config const KVStore = localforage.createInstance({ name: 'pl-fe', - description: 'pl-fe offline data store', + description: 'Nicolium offline data store', driver: localforage.INDEXEDDB, storeName: 'keyvaluepairs', }) as IKVStore;