Skip to content

Commit e640794

Browse files
authored
Create README.md
1 parent 9199225 commit e640794

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# World Heritage Explorer (Frontend)
2+
3+
World Heritage Explorer is a SPA to search and compare UNESCO World Heritage sites.
4+
5+
## Highlights
6+
7+
- Filter by **Region / Category / Keyword** (single "travel-style" search bar)
8+
- Clean list-to-detail navigation with image-first layout
9+
- UI stays **white-based even in dark mode** for readability
10+
11+
## Tech Stack
12+
13+
- React + TypeScript + Vite
14+
- React Router
15+
- TailwindCSS (white-based theme policy)
16+
- (Optional) Jest + Testing Library
17+
18+
## Architecture Notes
19+
20+
- Container components handle data fetching/state.
21+
- Presentational components focus on UI rendering.
22+
- Search parameters are handled as a single `SearchQuery` type.
23+
24+
## Getting Started
25+
26+
```bash
27+
cd client
28+
docker compose up -d --build
29+
docker compose exec frontend sh
30+
npm ci
31+
npm run dev -- --host 0.0.0.0 --port 3876
32+
```
33+
34+
> App runs at http://localhost:3876

0 commit comments

Comments
 (0)