Skip to content

Repository files navigation

knittingEditor

スマホを中心に設計した、ブラウザとiPhone・iPadで動作する棒針編み図エディタです。Canvasによる仮想描画で最大1000×1000セルを扱い、データは端末のIndexedDBへ自動保存します。

Web版とiOS版はこのリポジトリで管理します。盤面、記号、.knit形式、PNG/PDF生成の共通実装は packages/editor-core にあり、Web版はルート、iOS版は ios/ に配置しています。iOSのXcodeビルドはルートworkspaceから ios/Web を生成し、生成物をアプリへ同梱します。

旧knittingEditor_appリポジトリは統合前の履歴参照用です。現在の開発、Issue、CI、Web公開はすべてこのリポジトリで行います。

主な機能

  • 26種類の編み目記号と色指定
  • 1本指・マウスドラッグによる連続入力
  • 2本指パン・ピンチズーム、PCのホイール操作
  • 行・列の追加、挿入、削除、盤面サイズ変更
  • 複数の名前付き編み図を端末内で管理
  • 矩形パターンをブロックとして保存・貼付
  • PNG、1ページPDF、A4分割PDFへの出力
  • .knitバックアップの書出し・復元
  • 旧版localStorageデータの自動移行

開発

Node.js 24以上を使用します。

npm ci
npm run dev

品質確認は次のコマンドで実行します。

npm run typecheck
npm test
npm run build
npm run check:dist
npx playwright install chromium webkit
npm run test:e2e

iOS側のWeb bundleを確認する場合は、ルートで依存関係を導入した後に実行します。

cd ios
./scripts/build-web.sh
cd Web
../../node_modules/.bin/tsc -p tsconfig.app.json --noEmit
../../node_modules/.bin/vitest run --config vite.config.ts

配布

mainへの変更は、利用者がレビューしたPRのマージだけで行います(直接pushとforce pushはルールセットで禁止し、マージにはci-gateの成功が必要です)。マージ後、.github/workflows/ci.ymlが変更範囲に応じたWeb・iOS検証を実行します。Webまたは共通コードに影響する変更では、Web検証とiOS検証の成功後に、生成したdist/だけをGitHub Pagesへ公開します。公開後はsmokeジョブが、本番のHTMLが配信した成果物と一致することと、主要な資産・CNAME・HTTPSへの転送を確認します(手元ではnpm run check:live)。iOS専用変更ではPagesを再公開しません。公開先はknittingeditor.comです。

編み図はブラウザ内に保存されるため、重要なデータは「保存」メニューから定期的に.knitバックアップを取得してください。

未完了の作業はWeb版・iOS版ともGitHub Issuesで管理します。iOS版の初回リリースに必要な実機検証・署名・TestFlight・App Store提出の作業は、マイルストーンiOS 1.0にまとめています。

ライセンス

ソースコードは公開していますが、オープンソースではありません(All rights reserved)。閲覧と、Issue・Pull Requestのための複製・変更は自由です。許可なく再配布したり、アプリやWebサイトとして公開したりすることはできません。公式版で作成した編み図と出力ファイルの権利は利用者にあります。詳細はLICENSEを参照してください。

About

登録不要で使える無料の棒針編み図エディタ(Web版・iOS/iPadOS版)。26種類の編み目記号、PNG・PDF保存、.knitバックアップに対応。

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages