38 lines
758 B
Markdown
38 lines
758 B
Markdown
|
# Prefecture Map Generator
|
||
|
|
|
||
|
|
A browser-based procedural prefecture map generator.
|
||
|
|
|
||
|
|
## Project layout
|
||
|
|
|
||
|
|
- `src/` - application modules and web workers
|
||
|
|
- `styles/` - application styles
|
||
|
|
- `tests/` - reusable browser and Node.js tests
|
||
|
|
- `scripts/` - local development server helpers
|
||
|
|
- `archive/` - recoverable historical and legacy files, excluded from the active app
|
||
|
|
- `index.html` - application entry point
|
||
|
|
|
||
|
|
## Run locally
|
||
|
|
|
||
|
|
On Windows:
|
||
|
|
|
||
|
|
```bat
|
||
|
|
scripts\start_server.bat 8000
|
||
|
|
```
|
||
|
|
|
||
|
|
On macOS or Linux:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
./scripts/start_server.sh 8000
|
||
|
|
```
|
||
|
|
|
||
|
|
Then open `http://127.0.0.1:8000/`.
|
||
|
|
|
||
|
|
## Tests
|
||
|
|
|
||
|
|
Run the complete Node.js test suite from the project root:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
node tests/test-all.mjs
|
||
|
|
```
|
||
|
|
|
||
|
|
The browser test page is available at `http://127.0.0.1:8000/tests/test.html`.
|