Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# pay-crew

[![Test](https://github.com/Myxogastria0808/pay-crew/actions/workflows/test.yaml/badge.svg)](https://github.com/Myxogastria0808/pay-crew/actions/workflows/test.yaml)
[![Docs](https://github.com/Myxogastria0808/pay-crew/actions/workflows/docs.yaml/badge.svg)](https://github.com/Myxogastria0808/pay-crew/actions/workflows/docs.yaml)
![GitHub Release](https://img.shields.io/github/v/release/Myxogastria0808/pay-crew)
![GitHub License](https://img.shields.io/github/license/Myxogastria0808/pay-crew)
[![Test](https://github.com/Pay-Crew/pay-crew2/actions/workflows/test.yaml/badge.svg)](https://github.com/Pay-Crew/pay-crew2/actions/workflows/test.yaml)
[![Docs](https://github.com/Pay-Crew/pay-crew2/actions/workflows/docs.yaml/badge.svg)](https://github.com/Pay-Crew/pay-crew2/actions/workflows/docs.yaml)
![GitHub Release](https://img.shields.io/github/v/release/Pay-Crew/pay-crew)
![GitHub License](https://img.shields.io/github/license/Pay-Crew/pay-crew)
Comment on lines +5 to +6
Copy link

Copilot AI Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent repository references: Lines 3-4 use "Pay-Crew/pay-crew2" but lines 5-6 still use "Pay-Crew/pay-crew". All badge URLs should reference the same repository for consistency.

Suggested change
![GitHub Release](https://img.shields.io/github/v/release/Pay-Crew/pay-crew)
![GitHub License](https://img.shields.io/github/license/Pay-Crew/pay-crew)
![GitHub Release](https://img.shields.io/github/v/release/Pay-Crew/pay-crew2)
![GitHub License](https://img.shields.io/github/license/Pay-Crew/pay-crew2)

Copilot uses AI. Check for mistakes.
![Vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)
[![RenovateBot](https://img.shields.io/badge/RenovateBot-1A1F6C?logo=renovate&logoColor=fff)](#)

Expand All @@ -29,7 +29,7 @@ https://pay-crew.github.io/pay-crew/
1. このレポジトリをクローン

```sh
git clone https://github.com/Myxogastria0808/pay-crew.git
git clone https://github.com/Pay-Crew/pay-crew.git
Copy link

Copilot AI Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The git clone URL references "Pay-Crew/pay-crew.git" but the badge URLs above reference "Pay-Crew/pay-crew2". These should be consistent and point to the correct repository name.

Suggested change
git clone https://github.com/Pay-Crew/pay-crew.git
git clone https://github.com/Pay-Crew/pay-crew2.git

Copilot uses AI. Check for mistakes.
cd pay-crew
```

Expand Down Expand Up @@ -136,11 +136,11 @@ pnpm run backend:migrate
#### [Live Demo](https://pay-crew.yukiosada.work/)
- https://pay-crew.yukiosada.work/

#### [Source Code](https://github.com/Myxogastria0808/pay-crew/tree/dev/products/frontend/)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/products/frontend/
#### [Source Code](https://github.com/Pay-Crew/pay-crew2/tree/dev/products/frontend/)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/products/frontend/

#### [Details](https://github.com/Myxogastria0808/pay-crew/tree/dev/products/frontend/README.md)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/products/frontend/README.md
#### [Details](https://github.com/Pay-Crew/pay-crew2/tree/dev/products/frontend/README.md)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/products/frontend/README.md

#### [Vitest UI Report](https://pay-crew.github.io/pay-crew/vitest/frontend/)
- https://pay-crew.github.io/pay-crew/vitest/frontend/
Expand All @@ -162,11 +162,11 @@ pnpm run backend:migrate
#### [OpenAPI Spec](https://pay-crew-api.yukiosada.work/openapi)
- https://pay-crew-api.yukiosada.work/openapi

#### [Source Code](https://github.com/Myxogastria0808/pay-crew/tree/dev/products/backend/)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/products/backend/
#### [Source Code](https://github.com/Pay-Crew/pay-crew2/tree/dev/products/backend/)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/products/backend/

#### [Details](https://github.com/Myxogastria0808/pay-crew/tree/dev/products/backend/README.md)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/products/backend/README.md
#### [Details](https://github.com/Pay-Crew/pay-crew2/tree/dev/products/backend/README.md)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/products/backend/README.md

#### [Vitest UI Report](https://pay-crew.github.io/pay-crew/vitest/backend/)
- https://pay-crew.github.io/pay-crew/vitest/backend/
Expand All @@ -179,11 +179,11 @@ pnpm run backend:migrate
- TypeScript
- Zod

#### [Source Code](https://github.com/Myxogastria0808/pay-crew/tree/dev/products/validator/)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/products/validator/
#### [Source Code](https://github.com/Pay-Crew/pay-crew2/tree/dev/products/validator/)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/products/validator/

#### [Details](https://github.com/Myxogastria0808/pay-crew/tree/dev/products/validator/README.md)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/products/validator/README.md
#### [Details](https://github.com/Pay-Crew/pay-crew2/tree/dev/products/validator/README.md)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/products/validator/README.md

#### [Vitest UI Report](https://pay-crew.github.io/pay-crew/vitest/validator/)
- https://pay-crew.github.io/pay-crew/vitest/validator/
Expand All @@ -197,11 +197,11 @@ pnpm run backend:migrate
- Cloudflare Workers
- Discord Webhook

#### [Source Code](https://github.com/Myxogastria0808/pay-crew/tree/dev/products/notify/)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/products/notify/
#### [Source Code](https://github.com/Pay-Crew/pay-crew2/tree/dev/products/notify/)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/products/notify/

#### [Details](https://github.com/Myxogastria0808/pay-crew/tree/dev/products/notify/README.md)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/products/notify/README.md
#### [Details](https://github.com/Pay-Crew/pay-crew2/tree/dev/products/notify/README.md)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/products/notify/README.md

### Database

Expand All @@ -214,21 +214,21 @@ pnpm run backend:migrate

- Astro

#### [Docs](https://github.com/Myxogastria0808/pay-crew/tree/dev/docs/)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/docs/
#### [Docs](https://github.com/Pay-Crew/pay-crew2/tree/dev/docs/)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/docs/

#### [Details](https://github.com/Myxogastria0808/pay-crew/tree/dev/docs/README.md)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/docs/README.md
#### [Details](https://github.com/Pay-Crew/pay-crew2/tree/dev/docs/README.md)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/docs/README.md

### Setup (setup)

- TypeScript

#### [Source Code](https://github.com/Myxogastria0808/pay-crew/tree/dev/setup/)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/setup/
#### [Source Code](https://github.com/Pay-Crew/pay-crew2/tree/dev/setup/)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/setup/

#### [Details](https://github.com/Myxogastria0808/pay-crew/tree/dev/setup/README.md)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/setup/README.md
#### [Details](https://github.com/Pay-Crew/pay-crew2/tree/dev/setup/README.md)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/setup/README.md

#### [Vitest UI Report](https://pay-crew.github.io/pay-crew/vitest/setup/)
- https://pay-crew.github.io/pay-crew/vitest/setup/
Expand All @@ -240,8 +240,8 @@ pnpm run backend:migrate

- GitHub Actions with Nix

#### [CI/CD](https://github.com/Myxogastria0808/pay-crew/tree/dev/.github/workflows/)
- https://github.com/Myxogastria0808/pay-crew/tree/dev/.github/workflows/
#### [CI/CD](https://github.com/Pay-Crew/pay-crew2/tree/dev/.github/workflows/)
- https://github.com/Pay-Crew/pay-crew2/tree/dev/.github/workflows/

## テストツール

Expand Down
45 changes: 45 additions & 0 deletions products/backend/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,50 @@
# pay-crew Backend

## Xata LiteへのMigration方法

1. `products/backend/.env`の`POSTGRES_URL`の値に対象のXata Liteのデータベースの`DATABASE_URL_POSTGRES`を設定する。

2. `pnpm run backend:migrate`を実行する。

※ 事前に`pnpm i && pnpm run backend:generate`を実行しておくこと。

```sh
pnpm run backend:migrate
```

3. マイグレーションが完了したら、`products/backend/.env`の`POSTGRES_URL`の値を元の状態に戻す (削除する) 。

## Workersと接続するHyperdriveを変更する方法

1. `products/backend/wrangler.jsonc`の`HYPERDRIVE`の`ID`を変更する。

```jsonc
{
"$schema": "node_modules/wrangler/config-schema.json",
"name": "pay-crew2-backend",
"main": "src/index.ts",
"compatibility_date": "2025-12-03",
"compatibility_flags": ["nodejs_compat"],
"hyperdrive": [
{
"binding": "HYPERDRIVE",
"id": "", // <- ここを変更する
},
],
}

```

2. `pnpm run backend:deploy`を実行する。

```sh
pnpm run backend:deploy
```

3. デプロイが完了したら、`products/backend/wrangler.jsonc`の`HYPERDRIVE`の`ID`を`""` (元の状態) に戻す。

※ HyperdriveのIDが漏洩すると、他者にデータベースを操作される可能性があるため、デプロイ完了後は必ず元に戻してからステージング (`git add`) をすること。
Comment on lines +44 to +46
Copy link

Copilot AI Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Security concern: The documentation suggests manually emptying the Hyperdrive ID and relying on manual process to prevent leakage. Consider using environment variables or secrets management instead of committing sensitive configuration to version control, even temporarily.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The instruction refers to "ステージング (git add)" which typically means "staging" in Git terminology, not "staging environment". While technically correct, consider using "ステージングエリアへの追加" for clarity to distinguish from deployment staging environments.

Suggested change
※ HyperdriveのIDが漏洩すると、他者にデータベースを操作される可能性があるため、デプロイ完了後は必ず元に戻してからステージング (`git add`) をすること。
※ HyperdriveのIDが漏洩すると、他者にデータベースを操作される可能性があるため、デプロイ完了後は必ず元に戻してからステージングエリアへの追加 (`git add`) をすること。

Copilot uses AI. Check for mistakes.

## 構造

この構造は、レイヤードアーキテクチャから着想を得て定義している。
Expand Down
Loading