PaperStock

次世代のWikiエンジン

PaperStockは、「次世代」を目指し開発中の、パブリックWikiエンジンです。

一般公開を意図しており、企業内部などの閉ざされた環境での利用は意図していません。

特徴

• ログインせずとも読み書きできる、とっつきやすさ（ログイン必須にすることも可能）
• PC・モバイル両方に対応したユーザーインターフェイス
• ページにリアクションを付けられる
• 編集履歴が残り、過去のページにロールバックすることも可能
• サーバーサイドレンダリング + SPAによる、高速かつ軽量な表示
• Markdownを用いたシンプルなページ記述（HTMLをサポートすることも可能）
• ドラッグ＆ドロップするだけで画像をアップロード・ページに貼り付けられる手軽さ
• WebHook機能で、SlackやDiscordなどに更新通知を送信できる
• リッチかつセキュアなWeb APIで、Wikiを自動化

⚠ 開発中です

PaperStockはまだ開発中です。未知の不具合や未実装の機能が多く存在します。実運用環境での利用はサポートされていません。

また、1.0.0リリース時にマイグレーションファイルを全部まとめ直す予定があるため、データベース互換性についても一切保証されていません。

ご利用の際は、上記の点にご留意ください。実運用によって起こったトラブルについて、一切の責任を負いかねます。

ディレクトリ構成

• components/ - React コンポーネント
• libs/ - 外部ライブラリに関連するコード
• misc/ - 特定のジャンルに属さないコード
• models - インターフェイスや型エイリアス等の定義
• models/api - API 型定義
• pages/ - Next.js ページ
• pages/api - Next.js API Route による Web API 定義
• pages/s - システムページ
• prisma/ - Prisma.js で利用するコード
• public/ - 静的アセット

ビルド・実行方法

TBD

貢献方法

TBD

ライセンス

MIT ライセンス