Skip to content

Commit 0855eee

Browse files
committed
chore: delete redundant files
1 parent 78a208a commit 0855eee

File tree

3 files changed

+78
-120
lines changed

3 files changed

+78
-120
lines changed

README.md

Lines changed: 78 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,82 @@
1-
# World Heritage API
1+
# World Heritage API / 世界遺産 API
22

33
Backend API for a world heritage study app targeting users preparing for the World Heritage Certification exam.
4+
世界遺産検定を目指すユーザー向けの学習アプリのバックエンドAPIです。
5+
46
Fetches and manages UNESCO World Heritage data, providing APIs for search, listing, and detail retrieval.
7+
UNESCOの世界遺産データを取得・管理し、検索・一覧・詳細取得のAPIを提供します。
8+
9+
## Persona / ペルソナ
510

6-
Persona
711
This API powers a study app for people preparing for the World Heritage Certification Exam.
8-
Instead of carrying a heavy textbook, users can quickly look up heritage sites — their overview, location, and classification — from their smartphone or PC. The app targets anyone interested in the certification, regardless of age or experience.
9-
Example User
10-
Tanaka-san, 28, office worker
11-
Decided to take the World Heritage Certification Exam (Level 2). During the commute, she wants to quickly look up heritage sites on her phone, but the official textbook is too heavy to carry around. She needs a tool where she can check the location on a map along with the category and year of inscription — all in one place.
12+
このAPIは、世界遺産検定を受験する人向けの学習アプリを支えています。
1213

13-
## Tech Stack
14+
Instead of carrying a heavy textbook, users can quickly look up heritage sites — their overview, location, and classification — from their smartphone or PC.
15+
重いテキストを持ち歩かなくても、スマートフォンやPCから遺産の概要・場所・分類をすぐに調べられます。
1416

15-
- PHP / Laravel
16-
- MySQL
17-
- Algolia (Full-text search)
18-
- Koyeb (Production hosting)
17+
The app targets anyone interested in the certification, regardless of age or experience.
18+
年齢や経験を問わず、検定に興味があるすべての人を対象としています。
19+
20+
**Example User / ユーザー例**
21+
22+
Tanaka-san, 28, office worker.
23+
Decided to take the World Heritage Certification Exam (Level 2).
24+
During her commutation, she wants to quickly look up heritage sites on her phone,
25+
but the official textbook is too heavy to carry around.
26+
She needs a tool where she can check the location on a map along with the category and year of inscription — all in one place.
1927

20-
## Getting Started
28+
田中さん、28歳、会社員。
29+
世界遺産検定2級の受験を決意。
30+
通勤中にスマホでサッと調べたいけど、公式テキストは重くて持ち歩けない。
31+
地図上の場所・カテゴリー・登録年を一度に確認できるツールを求めている。
2132

33+
## Tech Stack / 技術スタック
34+
35+
- PHP / Laravel
36+
- MySQL (Aiven / クラウドデータベース管理)
37+
- Algolia (Full-text search / 全文検索)
38+
- Koyeb (Production hosting / 本番ホスティング)
39+
40+
## Getting Started / はじめに
2241
```bash
2342
cp .env.example .env
2443
composer install
2544
php artisan key:generate
2645
php artisan migrate
2746
```
2847

29-
## Building Data in Production
30-
31-
Run the following commands from the Koyeb console.
32-
33-
### Initial / Full rebuild
34-
35-
Dumps data from UNESCO and rebuilds the DB and Algolia index.
36-
48+
### Initial / Full rebuild / 初回・フル再構築
3749
```bash
3850
php artisan app:world-heritage-build --force --dump --jp --pretty
3951
```
4052

41-
| Option | Description |
53+
| Option | Description / 説明 |
4254
|---|---|
43-
| `--force` | Allow execution outside local/testing |
44-
| `--dump` | Dump JSON from UNESCO |
45-
| `--jp` | Import Japanese names |
46-
| `--pretty` | Pretty print JSON output |
47-
48-
### Full rebuild including DB and Algolia (with table reset)
55+
| `--force` | Allow execution outside local/testing / ローカル・テスト環境以外での実行を許可 |
56+
| `--dump` | Dump JSON from UNESCO / UNESCOからJSONをダンプ |
57+
| `--jp` | Import Japanese names / 日本語名をインポート |
58+
| `--pretty` | Pretty print JSON output / JSON出力を整形 |
4959

60+
### Full rebuild including DB and Algolia / DBとAlgoliaを含むフル再構築
5061
```bash
5162
php artisan app:world-heritage-build --fresh --jp --pretty --algolia --algolia-truncate --force
5263
```
5364

54-
> ⚠️ `--fresh` drops and recreates all tables. All existing data will be lost.
55-
56-
### Re-import Japanese names only
65+
> :warning: `--fresh` drops and recreates all tables. All existing data will be lost.
66+
> :warning: `--fresh` は全テーブルを削除して再作成します。
5767
68+
### Re-import Japanese names only / 日本語名のみ再インポート
5869
```bash
5970
php artisan world-heritage:import-japanese-names --force
6071
```
6172

62-
## Testing
63-
73+
## Testing / テスト
6474
```bash
65-
php artisan test
75+
./vendor/bin/phpunit ./
6676
```
6777

68-
## Architecture Overview
78+
## Architecture Overview / アーキテクチャ概要
79+
6980
```
7081
[Browser]
7182
@@ -81,44 +92,42 @@ php artisan test
8192
│ │
8293
│ ┌──────────────────────────────────────────────────────┐ │
8394
│ │ Presentation Layer │ │
84-
│ │ Controller / FormRequest │ │
95+
│ │ Controller / ViewModel │ │
8596
│ └───────────────────┬──────────────────────────────────┘ │
97+
│ ▲ ViewModel │
98+
│ │ │
99+
│ ┌───────────────────┴───────────────────────────────┐ │
100+
│ │ Application Layer │ │
101+
│ │ ListQuery / UseCase / DTO │ │
102+
│ └───────────────────┬───────────────────────────────┘ │
103+
│ │ │
104+
│ ▼ │
105+
│ ┌───────────────────────────────────────────────────┐ │
106+
│ │ Domain Layer │ │
107+
│ │ Entity │ │
108+
│ └───────────────────┬───────────────────────────────┘ │
86109
│ │ │
87-
│ ┌───────────┴────────────┐ │
88-
│ │ Write │ Read │
89-
│ ▼ ▼ │
90-
│ ┌───────────────┐ ┌─────────────────┐ │
91-
│ │ Application │ │ Application │ │
92-
│ │ UseCommand │ │ ListQuery │ │
93-
│ └───────┬───────┘ └────────┬────────┘ │
94-
│ │ │ │
95-
│ ▼ ▼ │
96-
│ ┌───────────────┐ ┌─────────────────┐ │
97-
│ │ Domain Layer │ │ QueryService │ │
98-
│ │ UseCase │ │ DTO │ │
99-
│ │ Entity │ └────────┬────────┘ │
100-
│ │ ValueObject │ │ │
101-
│ │ Repository │ │ │
102-
│ └───────┬───────┘ │ │
103-
│ │ │ │
104-
│ ┌───────▼───────┐ │ │
105-
│ │Infrastructure │ │ │
106-
│ │ Eloquent │ │ │
107-
│ │ Repository │ │ │
108-
│ └───────┬───────┘ │ │
109-
│ │ │ │
110-
└──────────┼───────────────────────┼──────────────────────────┘
111-
│ 一覧 / 詳細取得 │ キーワード検索
112-
▼ ▼
113-
┌─────────┐ ┌───────────┐
114-
│ MySQL │◀─── ID ───│ Algolia │
115-
│ (DB) │ │ (Search) │
116-
└─────────┘ └───────────┘
110+
│ ▼ │
111+
│ ┌───────────────────────────────────────────────────┐ │
112+
│ │ Infrastructure Layer │ │
113+
│ │ Eloquent Repository / QueryService │ │
114+
│ └───────────┬─────────────────────┬─────────────────┘ │
115+
│ │ │ │
116+
└──────────────┼─────────────────────┼────────────────────────┘
117+
│ 一覧 / 詳細取得 │ キーワード検索
118+
▼ ▼
119+
┌─────────┐ ┌───────────┐
120+
│ MySQL │◀─ ID ────│ Algolia │
121+
│ (DB) │ │ (Search) │
122+
└─────────┘ └───────────┘
123+
124+
Flow: ListQuery → Domain(Entity) → DTO → ViewModel → Presentation
125+
流れ: ListQuery → Domain(Entity) → DTO → ViewModel → Presentation
117126
```
118127

119-
## Related Repositories
128+
## Related Repositories / 関連リポジトリ
120129

121-
| Role | Repository |
130+
| Role / 役割 | Repository |
122131
|---|---|
123-
| Frontend | https://github.com/zigzagdev/world-heritage-frontend |
124-
| Backend API | https://github.com/zigzagdev/world-heritage-api |
132+
| Frontend / フロントエンド | https://github.com/zigzagdev/world-heritage-frontend |
133+
| Backend API / バックエンドAPI | https://github.com/zigzagdev/world-heritage-api |

src/app/Packages/Features/QueryUseCases/ListQuery/CreateWorldHeritageListQueryCollection.php

Lines changed: 0 additions & 22 deletions
This file was deleted.

src/app/Packages/Features/QueryUseCases/ListQuery/UpdateWorldHeritageListQueryCollection.php

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)