From cf7690e46fc843068c6c9f9ac3e2300cfc6c9204 Mon Sep 17 00:00:00 2001 From: tiennm99 Date: Mon, 3 Aug 2026 18:06:49 +0700 Subject: [PATCH] docs: describe the web/ + android/ layout at the repository root Adds a root README covering both subprojects and the CI matrix, folds the two identical Apache-2.0 copies into a single root LICENSE, and updates the web docs that named workflow files by their pre-move paths. --- .gitignore | 12 ++ android/LICENSE => LICENSE | 0 README.md | 56 +++++++++ web/LICENSE | 202 ------------------------------- web/README.md | 9 +- web/docs/codebase-summary.md | 4 +- web/docs/deployment-guide.md | 6 +- web/docs/project-overview-pdr.md | 2 +- web/docs/system-architecture.md | 2 +- 9 files changed, 80 insertions(+), 213 deletions(-) create mode 100644 .gitignore rename android/LICENSE => LICENSE (100%) create mode 100644 README.md delete mode 100644 web/LICENSE diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1480211 --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +# Agent and editor state +.agents/ +.claude/ +.vscode/ +.idea/ + +# OS +.DS_Store +Thumbs.db + +# Tooling scratch +repomix-output.xml diff --git a/android/LICENSE b/LICENSE similarity index 100% rename from android/LICENSE rename to LICENSE diff --git a/README.md b/README.md new file mode 100644 index 0000000..573d4c6 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Lô Tô + +*Lô tô hội chợ* — Vietnamese fairground bingo. One number caller, two shipping +targets: a static web app and a fully-offline Android APK that wraps it. + +Live: [tiennm99.github.io/loto](https://tiennm99.github.io/loto) + +## Layout + +| Path | What it is | +|------|------------| +| [`web/`](web) | SvelteKit static app — the game itself. pnpm, Vitest, deployed to GitHub Pages and Firebase Hosting. | +| [`android/`](android) | Capacitor wrapper that bundles `web/build` into an APK. npm + Gradle; the native project sits in `android/android/`. | + +`android/` builds `web/` as part of its own build, so a change under `web/` +reaches the APK on the next `npm run build` in `android/`. There is no version +pin between them — they ship from the same commit. + +## Quick start + +```bash +# web +cd web && pnpm install && pnpm dev + +# android debug APK (builds web/ first) +cd android && npm ci && npm run build && npm run assemble:debug +``` + +Per-project detail lives in [`web/README.md`](web/README.md) and +[`android/README.md`](android/README.md). + +## CI + +Workflows live at the repository root in `.github/workflows/`; each is prefixed +with the subproject it serves and filtered on the paths it cares about. + +| Workflow | Trigger | Result | +|----------|---------|--------| +| `web-verify-build` | push/PR touching `web/` | `pnpm test && pnpm build` | +| `web-deploy-github-pages` | push to `main` touching `web/` | publishes to GitHub Pages | +| `web-firebase-hosting-merge` | push to `main` touching `web/` | deploys to Firebase Hosting | +| `web-firebase-hosting-pull-request` | PR touching `web/` | Firebase preview channel | +| `android-build-debug` | push/PR touching `web/` or `android/` | unsigned debug APK artifact | +| `android-release` | tag `v*.*.*` | signed AAB + APK on the GH Release | + +## History + +This repository is the merge of the former `tiennm99/loto` (now `web/`) and +`tiennm99/loto-android` (now `android/`). Both histories are preserved commit +for commit and interleaved in commit-time order under a single root, so +`git log` reads as one timeline and `git log -- web/` or `git log -- android/` +each resolve on the current paths. + +## License + +Apache-2.0 — see [`LICENSE`](LICENSE). diff --git a/web/LICENSE b/web/LICENSE deleted file mode 100644 index d645695..0000000 --- a/web/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/web/README.md b/web/README.md index 110cc8b..bdc290c 100644 --- a/web/README.md +++ b/web/README.md @@ -7,7 +7,8 @@ No runtime TTS or server required. Live: [tiennm99.github.io/loto](https://tiennm99.github.io/loto) -Android port: [tiennm99/loto-android](https://github.com/tiennm99/loto-android) +Android port: [`android/`](../android) — a Capacitor wrapper that bundles this +app into a fully-offline APK. --- @@ -117,12 +118,12 @@ The script auto-discovers all available `vi-*` voices and writes an updated mani ## Deployment -Deployed to GitHub Pages via `.github/workflows/deploy-github-pages.yml` on push to -`main`. Build command: `pnpm build:gh` (sets `/loto` base path). Static output in +Deployed to GitHub Pages via `.github/workflows/web-deploy-github-pages.yml` on push +to `main`. Build command: `pnpm build:gh` (sets `/loto` base path). Static output in `build/`. --- ## License -Apache 2.0 +Apache-2.0 — see [`LICENSE`](../LICENSE) at the repository root. diff --git a/web/docs/codebase-summary.md b/web/docs/codebase-summary.md index 7be4e83..0e8274f 100644 --- a/web/docs/codebase-summary.md +++ b/web/docs/codebase-summary.md @@ -50,8 +50,8 @@ | `svelte.config.js` | adapter-static (HTML export), dual basePath via BUILD_PROFILE env, SvelteKit PWA plugin config. | | `vite.config.js` | Tailwind + SvelteKit + PWA plugins. codeserver HMR config (port, allowedHosts, hmr). | | `package.json` | SvelteKit 2, Svelte 5 (runes), Tailwind 4, Vite, @vite-pwa/sveltekit. Scripts: dev, dev:codeserver, build, build:gh, lint, test, test:watch. | -| `.github/workflows/deploy-github-pages.yml` | Canonical deploy. On push to `main`: `npm ci && npm run build:gh`, uploads `build/` as the GitHub Pages artifact, deploys to `https://tiennm99.github.io/loto/`. | -| `.github/workflows/verify-build.yml` | CI: on push/PR to main runs `npm test && npm run build` as a regression gate before the deploy job. | +| `.github/workflows/web-deploy-github-pages.yml` | Canonical deploy. On push to `main`: `npm ci && npm run build:gh`, uploads `build/` as the GitHub Pages artifact, deploys to `https://tiennm99.github.io/loto/`. | +| `.github/workflows/web-verify-build.yml` | CI: on push/PR to main runs `npm test && npm run build` as a regression gate before the deploy job. | | `eslint.config.mjs` | ESLint 9 flat config (@eslint/js + eslint-plugin-svelte). Declares Svelte 5 rune globals. | | `jsconfig.json` | Path alias `$lib`, no checkJs. | | `.gitignore` | Excludes node_modules, build, .env.local, etc. | diff --git a/web/docs/deployment-guide.md b/web/docs/deployment-guide.md index 793805e..5da8ac0 100644 --- a/web/docs/deployment-guide.md +++ b/web/docs/deployment-guide.md @@ -15,7 +15,7 @@ either profile without code changes. ## Production Deployment — GitHub Pages -Canonical deploy. Wired via `.github/workflows/deploy-github-pages.yml`: +Canonical deploy. Wired via `.github/workflows/web-deploy-github-pages.yml`: on push to `main`, runs `npm run build:gh`, uploads `build/` as the GitHub Pages artifact, and deploys. @@ -135,9 +135,9 @@ Generates: ## CI/CD Pipeline Two workflows on `main`: -- **`.github/workflows/deploy-github-pages.yml`** — canonical deploy. Builds +- **`.github/workflows/web-deploy-github-pages.yml`** — canonical deploy. Builds with `npm run build:gh` and publishes `build/` to GitHub Pages. -- **`.github/workflows/verify-build.yml`** — PR + push gate. Runs +- **`.github/workflows/web-verify-build.yml`** — PR + push gate. Runs `npm test && npm run build` to catch regressions before they reach the deploy job. diff --git a/web/docs/project-overview-pdr.md b/web/docs/project-overview-pdr.md index 9c0981d..13c0b43 100644 --- a/web/docs/project-overview-pdr.md +++ b/web/docs/project-overview-pdr.md @@ -86,7 +86,7 @@ State is entirely client-side. Each card / panel instance uses a unique localSto ## Deployment -- **Production**: GitHub Pages at `https://tiennm99.github.io/loto/` (canonical, basePath `/loto`). Deployed by `.github/workflows/deploy-github-pages.yml` on push to `main`. +- **Production**: GitHub Pages at `https://tiennm99.github.io/loto/` (canonical, basePath `/loto`). Deployed by `.github/workflows/web-deploy-github-pages.yml` on push to `main`. - **Development**: `npm run dev` (local), `npm run dev:codeserver` (code-server via proxy). - **Build**: `npm run build:gh` generates static export to `build/` directory with the `/loto` basePath. diff --git a/web/docs/system-architecture.md b/web/docs/system-architecture.md index 3674d23..b8dbc1d 100644 --- a/web/docs/system-architecture.md +++ b/web/docs/system-architecture.md @@ -74,7 +74,7 @@ npm run build:gh basePath="/loto" Output: build/index.html with /loto prefix Deploy: https://tiennm99.github.io/loto/ -Workflow: .github/workflows/deploy-github-pages.yml +Workflow: .github/workflows/web-deploy-github-pages.yml ``` ### Development (Local)