Skip to content

Commit 9199225

Browse files
committed
feat: update README.md
1 parent 290497e commit 9199225

2 files changed

Lines changed: 23 additions & 89 deletions

File tree

README.md

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

client/README.md

Lines changed: 23 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,34 @@
1-
# React + TypeScript + Vite
1+
# World Heritage Explorer (Frontend)
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
World Heritage Explorer is a SPA to search and compare UNESCO World Heritage sites.
44

5-
Currently, two official plugins are available:
5+
## Highlights
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
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
910

10-
## React Compiler
11+
## Tech Stack
1112

12-
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
13+
- React + TypeScript + Vite
14+
- React Router
15+
- TailwindCSS (white-based theme policy)
16+
- (Optional) Jest + Testing Library
1317

14-
## Expanding the ESLint configuration
18+
## Architecture Notes
1519

16-
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
20+
- Container components handle data fetching/state.
21+
- Presentational components focus on UI rendering.
22+
- Search parameters are handled as a single `SearchQuery` type.
1723

18-
```js
19-
export default defineConfig([
20-
globalIgnores(["dist"]),
21-
{
22-
files: ["**/*.{ts,tsx}"],
23-
extends: [
24-
// Other configs...
24+
## Getting Started
2525

26-
// Remove tseslint.configs.recommended and replace with this
27-
tseslint.configs.recommendedTypeChecked,
28-
// Alternatively, use this for stricter rules
29-
tseslint.configs.strictTypeChecked,
30-
// Optionally, add this for stylistic rules
31-
tseslint.configs.stylisticTypeChecked,
32-
33-
// Other configs...
34-
],
35-
languageOptions: {
36-
parserOptions: {
37-
project: ["./tsconfig.node.json", "./tsconfig.app.json"],
38-
tsconfigRootDir: import.meta.dirname,
39-
},
40-
// other options...
41-
},
42-
},
43-
]);
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
4432
```
4533

46-
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
47-
48-
```js
49-
// eslint.config.js
50-
import reactX from "eslint-plugin-react-x";
51-
import reactDom from "eslint-plugin-react-dom";
52-
53-
export default defineConfig([
54-
globalIgnores(["dist"]),
55-
{
56-
files: ["**/*.{ts,tsx}"],
57-
extends: [
58-
// Other configs...
59-
// Enable lint rules for React
60-
reactX.configs["recommended-typescript"],
61-
// Enable lint rules for React DOM
62-
reactDom.configs.recommended,
63-
],
64-
languageOptions: {
65-
parserOptions: {
66-
project: ["./tsconfig.node.json", "./tsconfig.app.json"],
67-
tsconfigRootDir: import.meta.dirname,
68-
},
69-
// other options...
70-
},
71-
},
72-
]);
73-
```
34+
> App runs at http://localhost:3876

0 commit comments

Comments
 (0)