README.md

Misskey Hub (Next)

Website for Misskey, built with Nuxt.

お知らせの文言のいじり方

app.config.ts から指定できます。

Docsの書き方

必ず /content/.README.md をご覧ください

NuxtLinkについて

内部リンク・外部リンクに関する処理を強化した<GNuxtLink>を使用していますので、リンクを追加する際は<NuxtLink>ではなく<GNuxtLink>を使用してください。

また、Nuxtのルーティングストラテジに、ホスティング環境に適した設定を適用するため、動的リンクの作成に使用するuseLocalePathをラップしたコンポーサブル関数useGLocalePathを使うようにしています。

Misskey Webへのリンクについて

GNuxtLinkおよび各種Docsで、アドレスに x-mi-web:// から始め、続けてMisskeyの相対パスを入力すると、Misskey Webへのリンクに置き換えられます。

例: /play → x-mi-web://play

Setup

Make sure to install the dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

Development Server

Start the development server on http://localhost:3000:

# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

Production

Note

このプログラムはMisskey Projectの使用するインフラストラクチャで動作するように設計されており、その他の環境で使用することは想定されていません。

This program is designed to run on the infrastructure used by the Misskey Project and is not intended to be used in other environments.

Build the application for production:

# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

Locally preview production build:

# npm
npm run preview

# pnpm
pnpm run preview

# yarn
yarn preview

Check out the deployment documentation for more information.

(おまけ) デプロイ時のオートメーションプログラム

/__misc/gas/ に、Misskey Hubデプロイ時に自動実行しているプログラムを同梱しています。

Google Apps Scriptで動作します。

License

GNU Affero General Public License v3.0

(c) 2023-2024 syuilo, kakkokari-gtyih and Misskey Project