48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
# UI-Docs
|
|
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
|
|
Walkthrough screenshots, usage instructions, and a review PDF for every operator, staff, portal, admin, simulator,...
|
|
|
|
**Forgejo:** https://git.georgelambert.org/marchon/UI-Docs
|
|
|
|
## Open the review
|
|
|
|
- [UI-REVIEW.pdf](UI-REVIEW.pdf) — screenshots, how to use each screen, remaining issues
|
|
- [WALKTHROUGH.md](WALKTHROUGH.md) — click-by-click
|
|
- [REPORT.md](REPORT.md) — issues still to consider
|
|
- [screenshots/](screenshots/) — PNG atlas
|
|
|
|
## Recapture
|
|
|
|
Lab processes must already be listening (`:3850` fleet, `:3847` simulator, `:3011` CS, `:3012` sales, `:3013` accounting, `:3025` staff, `:3000` edge).
|
|
|
|
```bash
|
|
npm install
|
|
npm run walk # headless Chrome → screenshots/ + walkthrough-console.json
|
|
npm run pdf # reportlab → UI-REVIEW.pdf
|
|
```
|
|
|
|
Chrome path: `CHROME_PATH` or `/Applications/Google Chrome.app/Contents/MacOS/Google Chrome`.
|
|
|
|
## Install
|
|
|
|
```sh
|
|
git clone ssh://git@git.georgelambert.org:2223/marchon/UI-Docs.git
|
|
cd UI-Docs
|
|
```
|
|
|
|
## Usage
|
|
|
|
```sh
|
|
# No single entrypoint is declared in this tree.
|
|
ls
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Questions: open an issue at https://git.georgelambert.org/marchon/UI-Docs/issues. Pull requests are accepted.
|
|
|
|
## License
|
|
|
|
UNLICENSED © George Lambert
|