map/README.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

2026-08-08 17:41:30 +09:00
# Prefecture Map Generator
2026-08-11 21:51:07 +09:00
Browser-based procedural prefecture map generator.
2026-08-08 17:41:30 +09:00
## Project layout
- `src/` - application modules and web workers
- `styles/` - application styles
2026-08-11 21:51:07 +09:00
- `tests/` - browser and Node.js regression tests
2026-08-08 17:41:30 +09:00
- `scripts/` - local development server helpers
- `index.html` - application entry point
2026-08-11 21:51:07 +09:00
2026-08-08 17:41:30 +09:00
## Run locally
2026-08-11 21:51:07 +09:00
Windows:
2026-08-08 17:41:30 +09:00
```bat
scripts\start_server.bat 8000
```
2026-08-11 21:51:07 +09:00
macOS / Linux:
2026-08-08 17:41:30 +09:00
```sh
./scripts/start_server.sh 8000
```
2026-08-11 21:51:07 +09:00
Open `http://127.0.0.1:8000/`.
2026-08-08 17:41:30 +09:00
## Tests
2026-08-11 21:51:07 +09:00
The default manifest runs the fast, canonical Node.js gates:
2026-08-08 17:41:30 +09:00
```sh
node tests/test-all.mjs
```
2026-08-11 21:51:07 +09:00
The release manifest includes the default gates plus the longer production,
quality, cancellation, and mirror-synchronization checks:
2026-08-10 13:59:33 +09:00
```sh
2026-08-11 21:51:07 +09:00
TEST_GROUP=release node tests/test-all.mjs
2026-08-10 13:59:33 +09:00
```
2026-08-11 21:51:07 +09:00
The browser manifest launches the application-level Chromium regression test:
2026-08-10 13:59:33 +09:00
```sh
2026-08-11 21:51:07 +09:00
TEST_GROUP=browser node tests/test-all.mjs
2026-08-10 13:59:33 +09:00
```
2026-08-11 21:51:07 +09:00
On PowerShell, set a group with `$env:TEST_GROUP = "release"` (or
`"browser"`) before running the same command. To run specific registered
suites, provide a comma-separated `TEST_SUITES` value. Unknown suite and group
names fail immediately rather than succeeding without assertions.