|
1 | 1 | <div align="center"> |
2 | 2 | <h1>Thyroid TNM Tool</h1> |
3 | | - <p><strong>Standalone PC and mobile web app for thyroid cancer TNM staging and treatment planning.</strong></p> |
| 3 | + <p><strong>Product-style PC and mobile web app for thyroid cancer TNM staging, treatment planning, and follow-up reference.</strong></p> |
4 | 4 | <p><a href="README.zh-CN.md">简体中文</a> | <strong>English</strong></p> |
| 5 | + |
5 | 6 | <p> |
6 | 7 | <a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="Latest Release" src="https://img.shields.io/github/v/release/liqi3333/thyroid?display_name=tag&label=release" /></a> |
| 8 | + <a href="https://github.com/liqi3333/thyroid/releases"><img alt="Downloads" src="https://img.shields.io/github/downloads/liqi3333/thyroid/total?label=downloads" /></a> |
7 | 9 | <a href="https://github.com/liqi3333/thyroid/actions/workflows/build-html.yml"><img alt="Build HTML" src="https://github.com/liqi3333/thyroid/actions/workflows/build-html.yml/badge.svg" /></a> |
8 | 10 | <a href="https://github.com/liqi3333/thyroid/actions/workflows/release.yml"><img alt="Release HTML" src="https://github.com/liqi3333/thyroid/actions/workflows/release.yml/badge.svg" /></a> |
9 | 11 | </p> |
| 12 | + |
10 | 13 | <p> |
11 | | - <a href="https://liqi3333.github.io/thyroid/"><img alt="Open Online" src="https://img.shields.io/badge/Open-Online%20Page-0ea5e9?style=for-the-badge" /></a> |
| 14 | + <a href="https://liqi3333.github.io/thyroid/"><img alt="Open PC Web" src="https://img.shields.io/badge/Open-PC%20Web-0ea5e9?style=for-the-badge" /></a> |
12 | 15 | <a href="https://liqi3333.github.io/thyroid/mobile.html"><img alt="Open Mobile Web" src="https://img.shields.io/badge/Open-Mobile%20Web-f59e0b?style=for-the-badge" /></a> |
13 | | - <a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="Download HTML" src="https://img.shields.io/badge/Download-Latest%20HTML-10b981?style=for-the-badge" /></a> |
| 16 | + <a href="https://github.com/liqi3333/thyroid/releases/latest"><img alt="Download Latest HTML" src="https://img.shields.io/badge/Download-Latest%20HTML-10b981?style=for-the-badge" /></a> |
14 | 17 | </p> |
15 | 18 | </div> |
16 | 19 |
|
17 | 20 | ## Overview |
18 | 21 |
|
19 | | -This project packages both a standalone desktop HTML page and a separate mobile-optimized HTML page for thyroid cancer TNM staging, treatment planning, and follow-up suggestions into a shareable GitHub repository with release automation and GitHub Pages deployment. |
| 22 | +Thyroid TNM Tool packages a single-file clinical HTML interface into a deliverable product with a public GitHub repository, standalone HTML downloads, GitHub Pages deployment, and automated releases. |
| 23 | + |
| 24 | +It now provides two separate web entry points: |
| 25 | + |
| 26 | +- **PC web version**: preserves the original desktop-style layout |
| 27 | +- **Mobile web version**: a separate `mobile.html` optimized for phone browsers |
| 28 | + |
| 29 | +## Why this project is useful |
| 30 | + |
| 31 | +- Fast AJCC 8th edition thyroid cancer staging lookup |
| 32 | +- Treatment planning and follow-up suggestions in the same screen |
| 33 | +- No backend, no installation required for web usage |
| 34 | +- Can be opened online or downloaded as a standalone HTML file |
| 35 | +- Keeps PC and mobile experiences separate instead of forcing one responsive compromise |
20 | 36 |
|
21 | 37 | ## Access |
22 | 38 |
|
23 | 39 | - GitHub repository: <https://github.com/liqi3333/thyroid> |
24 | | -- Online PC page: <https://liqi3333.github.io/thyroid/> |
25 | | -- Online mobile page: <https://liqi3333.github.io/thyroid/mobile.html> |
| 40 | +- PC web page: <https://liqi3333.github.io/thyroid/> |
| 41 | +- Mobile web page: <https://liqi3333.github.io/thyroid/mobile.html> |
26 | 42 | - Latest release: <https://github.com/liqi3333/thyroid/releases/latest> |
| 43 | +- All releases: <https://github.com/liqi3333/thyroid/releases> |
| 44 | + |
| 45 | +## Delivery formats |
| 46 | + |
| 47 | +The repository currently ships these forms: |
| 48 | + |
| 49 | +- `index.html`, original PC web version |
| 50 | +- `mobile.html`, separate phone-optimized version |
| 51 | +- Release asset: `Thyroid-TNM-Tool-1.0.1.html` |
| 52 | +- Release asset: `Thyroid-TNM-Tool-mobile-1.0.1.html` |
| 53 | + |
| 54 | +## Quick Start |
| 55 | + |
| 56 | +### Use online |
| 57 | + |
| 58 | +- Open the PC page: <https://liqi3333.github.io/thyroid/> |
| 59 | +- Open the mobile page: <https://liqi3333.github.io/thyroid/mobile.html> |
| 60 | + |
| 61 | +### Download standalone HTML |
27 | 62 |
|
28 | | -## Local usage |
| 63 | +Download the latest files from: |
29 | 64 |
|
30 | | -Open `index.html` directly in a browser, or generate the release-ready HTML file: |
| 65 | +- <https://github.com/liqi3333/thyroid/releases/latest> |
| 66 | + |
| 67 | +Then open either HTML file directly in a browser. |
| 68 | + |
| 69 | +### Build locally |
31 | 70 |
|
32 | 71 | ```bash |
33 | 72 | npm run build:html |
34 | 73 | ``` |
35 | 74 |
|
36 | | -Output: |
| 75 | +Build outputs: |
37 | 76 |
|
38 | 77 | ```text |
39 | 78 | dist-html/Thyroid-TNM-Tool-1.0.1.html |
40 | 79 | dist-html/Thyroid-TNM-Tool-mobile-1.0.1.html |
41 | 80 | ``` |
42 | 81 |
|
43 | | -## Automation |
| 82 | +## Product highlights |
| 83 | + |
| 84 | +- Thyroid cancer TNM staging interface |
| 85 | +- Treatment plan and follow-up recommendation panel |
| 86 | +- Standalone offline-friendly HTML distribution |
| 87 | +- Separate PC and mobile web entry points |
| 88 | +- Public GitHub Pages deployment |
| 89 | +- Automated GitHub Actions build and release workflow |
| 90 | +- Bilingual project documentation |
| 91 | + |
| 92 | +## Release automation |
| 93 | + |
| 94 | +This repository includes GitHub Actions workflows for delivery automation. |
| 95 | + |
| 96 | +- Push to `main`: build validation and upload HTML artifacts |
| 97 | +- Push a tag such as `v1.0.1`: generate desktop and mobile standalone HTML files, then publish them to GitHub Releases |
| 98 | +- GitHub Pages serves both `index.html` and `mobile.html` |
| 99 | + |
| 100 | +Example: |
44 | 101 |
|
45 | | -- Push to `main`: run HTML build and upload desktop + mobile workflow artifacts |
46 | | -- Push a tag like `v1.0.1`: build both desktop/mobile HTML files and publish them to GitHub Releases |
47 | | -- GitHub Pages serves `index.html` and `mobile.html` |
| 102 | +```bash |
| 103 | +git tag v1.0.1 |
| 104 | +git push origin v1.0.1 |
| 105 | +``` |
| 106 | + |
| 107 | +## Project structure |
| 108 | + |
| 109 | +```text |
| 110 | +. |
| 111 | +├── docs/ |
| 112 | +│ └── RELEASE_TEMPLATE.md |
| 113 | +├── scripts/ |
| 114 | +│ └── build-html-release.js |
| 115 | +├── index.html |
| 116 | +├── mobile.html |
| 117 | +├── package.json |
| 118 | +├── README.md |
| 119 | +├── README.zh-CN.md |
| 120 | +└── .github/workflows/ |
| 121 | + ├── build-html.yml |
| 122 | + └── release.yml |
| 123 | +``` |
48 | 124 |
|
49 | 125 | ## Notes |
50 | 126 |
|
51 | | -- This repository currently focuses on the web version only |
| 127 | +- This repository currently focuses on web delivery only, not EXE packaging |
52 | 128 | - Medical content is for informational use only and does not replace formal clinical decision-making |
0 commit comments