Skip to content

otomatty/zedi

Repository files navigation

Zedi Logo

Zedi

Zero-Friction Knowledge Network
思考を宇宙のように拡張する、AIネイティブなナレッジアプリ

FeaturesDemoGetting StartedTech StackRoadmapContributing

Status: Alpha License: MIT PRs Welcome


🌟 Overview

Zedi は、「書くストレス」と「整理する義務」からあなたを解放するナレッジアプリです。

従来のメモアプリでは、情報をフォルダに分類し、手動でリンクを作成する必要がありました。Zedi は AI による足場生成(Scaffolding)と WikiLink によるネットワーク構造で、思考を自然に拡張させます。

💡 デザイン原則

  • Speed & Flow — 起動0秒、保存不要。思考の速度で書ける
  • Context over Folder — フォルダ不要。時間とリンクで自然に整理
  • Atomic & Constraint — 1ページ1アイデア。小さく繋げる
  • Scaffolding by AI — AIが知識の足場を自動生成
  • Dormant Seeds — 未整理のメモも「発芽待ちの種」として許容

✨ Features

📅 Date Grid

日付ごとにグループ化されたページをグリッド表示。「いつ何を書いたか」が一目瞭然。

🔗 WikiLinks

[[ページタイトル]] 記法で簡単にページ間リンク。オートコンプリート付きで既存ページにすばやくアクセス。

🤖 AI Wiki Generator

キーワードを選択して AI に解説を生成させると、関連トピックへのリンクも自動挿入。知識のネットワークが自動的に広がります。

🌐 Web Clipper

URL を入力するだけで Web ページの本文を自動抽出。あとから自分のペースでキーワードをリンク化できます。

🔍 Global Search

Cmd+K / Ctrl+K で全文検索を起動。キーワードを含むページを瞬時に発見。

🔀 Linked Pages

ページ下部に関連ページを自動表示:

  • Outgoing Links — このページからリンクしている先
  • Backlinks — このページにリンクしている元
  • 2-hop Links — リンク先のリンク先まで辿れる

⌨️ Keyboard Shortcuts

  • Cmd/Ctrl + K — グローバル検索
  • Cmd/Ctrl + N — 新規ページ作成
  • Cmd/Ctrl + H — ホーム画面へ
  • Cmd/Ctrl + / — ショートカット一覧

📝 Markdown Editor

Tiptap ベースのリッチエディタ。Markdown ショートカットでシームレスに書ける。

  • # → 見出し
  • - → 箇条書き
  • > → 引用
  • **text** → 太字
  • ` → コードブロック

🎬 Demo

🚧 Coming Soon — スクリーンショットとデモ動画を準備中です


🚀 Getting Started

前提条件

  • Bun v1.0 以上(推奨)
  • または Node.js v18 以上

インストール

# リポジトリをクローン
git clone https://github.com/your-username/zedi.git
cd zedi

# 依存関係をインストール
bun install

# 開発サーバーを起動
bun run dev

ブラウザで http://localhost:5173 を開いてください。

環境変数の設定(オプション)

AI 機能や認証機能を使用する場合は、.env.local ファイルを作成してください:

# Clerk 認証(オプション)
VITE_CLERK_PUBLISHABLE_KEY=your_clerk_key

# Turso データベース(オプション - ローカル SQLite でも動作します)
# 認証はClerkのJWTトークンを使用するため、VITE_TURSO_AUTH_TOKENは不要です
VITE_TURSO_DATABASE_URL=libsql://your-database-name.aws-ap-northeast-1.turso.io

Note: 環境変数なしでもローカル SQLite で動作します。AI 機能は設定画面から API キーを入力して使用できます。

トラブルシューティング

本番環境でクラウド同期が失敗する場合(CORSエラーや401エラー)は、トラブルシューティングガイドを参照してください。


🛠 Tech Stack

Category Technology
Frontend React 18 + TypeScript
Build Tool Vite
Editor Tiptap (ProseMirror)
Styling Tailwind CSS + shadcn/ui
State Zustand + TanStack Query
Auth Clerk
Database libsql (in-memory + IndexedDB) / Turso
AI OpenAI / Anthropic / Google Gemini
Testing Vitest + Playwright

🗺 Roadmap

✅ 完了

  • React + Vite 基盤構築
  • ページの CRUD 操作
  • Date Grid UI
  • WikiLink 機能(サジェスト付き)
  • AI Wiki Generator
  • Web Clipper
  • Global Search
  • キーボードショートカット
  • Clerk 認証連携
  • Markdown エクスポート
  • Backlinks / 2-hop Links 表示
  • Linked Pages カード表示

🔄 開発中

  • Turso リアルタイム同期

📋 予定

  • Tauri 2.0 デスクトップアプリ
  • iOS / Android モバイルアプリ
  • Share Sheet 連携
  • Magic Split / Flick-to-Split
  • Ghost Link System
  • Semantic Search(ベクトル検索)

詳細は PRD を参照してください。


🧪 Testing

# ユニットテスト
bun run test

# E2E テスト
bun run test:e2e

# テストカバレッジ
bun run test:coverage

📁 Project Structure

src/
├── components/          # React コンポーネント
│   ├── editor/          # エディタ関連
│   ├── page/            # ページ表示関連
│   ├── search/          # 検索関連
│   ├── layout/          # レイアウト
│   └── ui/              # shadcn/ui コンポーネント
├── hooks/               # カスタムフック
├── lib/                 # ユーティリティ
├── pages/               # ページコンポーネント
├── stores/              # Zustand ストア
└── types/               # TypeScript 型定義

🤝 Contributing

コントリビューションを歓迎します!

  1. このリポジトリをフォーク
  2. 機能ブランチを作成 (git checkout -b feature/amazing-feature)
  3. 変更をコミット (git commit -m 'Add amazing feature')
  4. ブランチをプッシュ (git push origin feature/amazing-feature)
  5. Pull Request を作成

詳細は CONTRIBUTING.md を参照してください。


📄 License

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。


🙏 Acknowledgments

  • Tiptap — 素晴らしいエディタフレームワーク
  • shadcn/ui — 美しい UI コンポーネント
  • Clerk — シームレスな認証
  • Turso — エッジ対応データベース

Made with ❤️ by the Zedi Team

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages