Skip to content

otomatty/circle

Repository files navigation

Circle

Circleアプリケーションは、プロジェクト管理とタスク追跡のためのスタンドアロンアプリケーションです。

概要

Circleは、MakerKit依存から独立し、SQLiteデータベースを使用するスタンドアロンアプリケーションとして再構築されました。認証機能は廃止され、誰でもアクセス可能なアプリケーションとなっています。

技術スタック

  • フレームワーク: Next.js 15.2.3
  • データベース: SQLite (better-sqlite3)
  • UI: React 19, Tailwind CSS, shadcn/ui
  • 状態管理: Jotai
  • 国際化: i18next
  • パッケージマネージャー: Bun

セットアップ

前提条件

  • Node.js 18以上
  • Bun 1.2以上

インストール

  1. リポジトリをクローンします:
git clone <repository-url>
cd circle
  1. 依存関係をインストールします:
bun install
  1. 環境変数を設定します:
cp .env.example .env.local

.env.localファイルを編集し、必要な環境変数を設定してください。

  1. データベースを初期化します:
bun run db:init
  1. (オプション)シードデータを挿入します:
bun run seed:database

開発サーバーの起動

bun run dev

アプリケーションは http://localhost:3000 で起動します。

スクリプト

  • bun run dev - 開発サーバーを起動
  • bun run build - 本番用ビルドを作成
  • bun run start - 本番サーバーを起動
  • bun run lint - リンターを実行
  • bun run format - コードをフォーマット
  • bun run typecheck - TypeScriptの型チェックを実行
  • bun run db:init - データベースを初期化
  • bun run seed:database - シードデータを挿入

プロジェクト構造

circle/
├── app/                    # Next.js App Router
├── components/             # Reactコンポーネント
│   └── ui/                # shadcn/uiコンポーネント
├── lib/                    # ユーティリティとヘルパー
│   ├── db/                # SQLiteデータベース
│   └── i18n/              # i18n実装
├── actions/               # Server Actions
├── store/                 # Jotaiストア
├── types/                 # TypeScript型定義
├── hooks/                 # React Hooks
├── config/                # 設定ファイル
├── mock-data/             # モックデータ
├── scripts/               # スクリプト
└── public/                # 静的ファイル

データベース

SQLiteデータベースはdatabase.sqliteとしてプロジェクトルートに作成されます。このファイルは.gitignoreに含まれているため、リポジトリにはコミットされません。

スキーマ

データベーススキーマはlib/db/schema.sqlで定義されています。主なテーブル:

  • statuses - ステータス
  • priorities - 優先度
  • labels - ラベル
  • users - ユーザー
  • teams - チーム
  • team_members - チームメンバー
  • projects - プロジェクト
  • issues - タスク(イシュー)

環境変数

必要な環境変数については.env.exampleを参照してください。

ライセンス

[ライセンス情報を追加]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors