Use the one-liner abover, or use the [`docker-compose.yml`](https://github.com/Lissy93/domain-locker/blob/main/docker-compose.yml)

<details>
	<summary>詳細</summary>

 
- **前提条件**:
  - Domain Locker はコンテナで実行することを想定しているため、ホストシステムに Docker が[インストール](https://docs.docker.com/engine/install/)されている必要があります。
- **コンテナ**:
  - Docker イメージは [`lissy93/domain-locker`](https://hub.docker.com/r/lissy93/domain-locker) に公開されています。
  - また、[`postgres:15-alpine`](https://hub.docker.com/_/postgres?tab=tags&name=15-alpine) コンテナなどの Postgres データベースが必要です。
- **環境変数**:
  - コンテナ起動時には、コンテナ内の `3000` をホストの `PORT`（デフォルトは `3000`）にバインドします。
  - 次に、Postgres の変数 `DL_PG_HOST`、`DL_PG_PORT`、`DL_PG_USER`、`DL_PG_PASSWORD`、`DL_PG_NAME` を指定します。
- **ボリューム**:
  - `/var/lib/postgresql/data` にボリュームをマウントして、Postgres データを永続化します
- **Cron ジョブ**
  - `/api/domain-updater` - 毎日実行し、ドメインデータを最新に保ち、通知をトリガーします
  - `/api/domain-monitor` - 15分ごとに実行し、ウェブサイトのアップタイムとパフォーマンスを監視します
  - `/api/cleanup-monitor-data` - 毎週実行し、古い監視データを集約します

- **例**:
  - すべてをまとめて、[`docker-compose.yml`](https://github.com/Lissy93/domain-locker/blob/main/docker-compose.yml) ファイルを使用できます。
  - 詳細については、[セルフホスティングドキュメント](https://domain-locker.com/about/self-hosting) を参照してください。


<details>
<summary>Docker ダイアグラム</summary>```mermaid
flowchart TB
  subgraph Volume Mounts
    direction TB
    Vpostgresdata([📦 postgres_data]) x-. /var/lib/postgresql/data .-x postgres[(🐘 PostgreSQL DB)]
    Vdbschemasql{{📄 ./db/schema.sql}} -. Mounted on Init .-> postgres
  end

  subgraph Network
    direction TB
    domainlockernetwork[/🌐 domain_locker_network/]
  end

  postgres -.- domainlockernetwork

  subgraph app[⚙️ App Container]
    SSR[HTTP Server]
    CLIENT[Client App]
    API[API Endpoints]
    SSR --> CLIENT
    SSR --> API
  end

  app -.- domainlockernetwork

- **前提条件**
  - システムにGitとNodeがインストールされている必要があります。
- **設定**
  - サンプルの`.env.sample`ファイルには、Supabaseの開発インスタンスの公開資格情報が含まれています。
  - 別のデータベースを使用する場合は、以下の[データベース](#database)セクションを参照してPostgresで設定してください。
- **デプロイ**
  - `npm run build`でコードをビルドし、`npm start`で実行できます。
  - または、Dockerを使用して`docker build -t domain-locker .`でコンテナをビルドします。
  - 開発用Supabaseインスタンスは頻繁にワイプされるため、本番環境では使用しないでください。

---

## アプリケーションアーキテクチャ

#### 技術スタック

Domain Lockerは、アプリ、データベース、およびいくつかのAPIエンドポイントで構成されています。
- **アプリ**はAngularで構築され、Analog+Nitro、PrimeNgコンポーネント、Tailwindによるスタイリングを使用しています。
- **サーバー**は、Typescript関数を使用した一連のDenoエンドポイントです。
- **データベース**はPostgresまたはSupabaseのいずれかを使用できます。

セルフホストインスタンスはスタンドアロンでデプロイされることを想定していますが、管理バージョンは以下に示すいくつかの追加のサードパーティサービスに依存しており、[そのドキュメントはこちら](https://domain-locker.com/about/developing/third-party-docs)にあります。

<details>
<summary>理由</summary>
なぜAngularなのか？将来の自分に対する一種の悪趣味なジョークで、これをメンテナンスしなければならない自分へのものです。
</details>


<p align="center">
<img width="800" src="https://assets.kitploit.com/production/public/readmes/264/1449d16cb6a07bd766d3b86a8de608aaa4075270a0a634cd6f6af1f1a1d70c49.png" />
<br>
<span>使用されているテクノロジーとサービスのドキュメントは<a href="https://domain-locker.com/about/developing/third-party-docs">こちら</a>でご覧いただけます。</span>
</p>


#### アーキテクチャ

アーキテクチャは非常にシンプルです。
フロントエンドとAPIエンドポイントで構成されるアプリがあり、ユーザーは（アダプターを介して）データベースに対して読み取りおよび書き込みを行うことができます。次に、cronサービスが定期的にAPIエンドポイントを呼び出して、ドメインデータを最新の状態に保ち、変更を追跡し、ヘルスを監視し、特定の変更（ユーザーの設定に応じて）または期限切れが近づいた場合に通知をトリガーします。```mermaid
graph TD;
    subgraph User Interactions
        User[👤 User] -->|Enter domain| WebApp[🌐 Frontend];
        WebApp -->|Send API request| API[⚙️ Nitro API];
        API -->|Auth Check| Auth[🔐 Auth Service];
        API -->|Store domain info| Database[🗄️ PostgreSQL / Supabase];
    end

    subgraph Automated Cron Jobs
        CronService[⏳ Cron Service] -->|Trigger Updates| EdgeFunctions[⚡ Edge Functions];
        EdgeFunctions -->|Fetch WHOIS, DNS, SSL| ExternalAPIs[🌎 Analysis Services];
        EdgeFunctions -->|Store Data| Database;
        
        CronService -->|Monitor Uptime| WebsiteMonitor[📡 Uptime Monitor];
        WebsiteMonitor -->|Store Metrics| Database;

        CronService -->|Check Expirations| ExpiryChecker[📆 Expiration Check];
        ExpiryChecker -->|Update Status| Database;
        
        CronService -->|Send Notifications| NotificationService[🔔 Notification System];
        NotificationService -->|Email| Resend[📧 Resend];
        NotificationService -->|SMS| Twilio[📱 Twilio];
    end

    Database -->|Serve Data| WebApp;

<p align="center"><sub>スキーマは <a href="https://github.com/Lissy93/domain-locker/blob/main/db/schema.sql"<code>db/schema.sql</code></a> からダウンロードできます。</sub></p>

---

### コントリビューション

あらゆる種類のコントリビューションはいつでも歓迎しており、大変感謝しています！💗

Git に不慣れな場合、一般的なコントリビューションの流れは以下の通りです：
- リポジトリをフォークするには、[ここをクリック](https://github.com/lissy93/domain-locker/fork)
- フォークをクローンする (`git clone [email protected]:[your_username]/domain-locker.git`)
- 上記の[プロジェクトのセットアップ](#project-setup)に従って、開発モードでプロジェクトを動かせるようにしてください
- あなたの素晴らしい新機能や驚くべきバグ修正を実装してください...
- ブランチをチェックアウト (`git checkout -b feature-branch`) し、変更を `git add` して、従来のコミット形式で `git commit` し、ブランチに `git push` してください
- GitHub に戻り、`main` ブランチに対して PR を開いてください。変更内容、理由、関連する Issue へのリンクを必ず含めてください。
- その後、レビュー、フィードバック、マージを行い、リリースされれば、あなたの変更は本番環境に反映され、最新の Docker イメージでも利用可能になります。

<details>
	<summary>Git ブランチの例</summary>```mermaid
%%{init: {"theme": "default"}}%%
gitGraph
    commit id: "Initial commit"
    branch trunk
    commit id: "Feature A"
    commit id: "Feature B"
    commit id: "v1.0.0 (Tag)"
    branch demo
    checkout main
    commit id: "Feature C"
    commit id: "v1.1.0 (Tag)"
    checkout demo
    merge main id: "Merge main into demo"
    checkout main
    commit id: "Feature D"
    commit id: "v1.2.0 (Tag)"
    checkout demo
    merge main id: "Merge main into demo (v1.2.0)"
    checkout main
    branch feature-branch-1
    commit id: "Contributor Feature 1"
    checkout main
    merge feature-branch-1 id: "Merge contributor feature 1"
    commit id: "v1.3.0 (Tag)"
    checkout demo
    merge main id: "Merge main into demo (v1.3.0)"
    checkout main
    branch feature-branch-2
    commit id: "Contributor Feature 2"
    checkout main
    merge feature-branch-2 id: "Merge contributor feature 2"
    commit id: "v1.4.0 (Tag)"
    checkout demo
    merge main id: "Merge main into demo (v1.4.0)"