commit 7b75a72a16e2029bd8c3aef4aa085d02301177d5 Author: tiennm99 Date: Thu Apr 30 21:44:43 2026 +0700 feat: initial scaffold - SvelteKit 2 + Svelte 5 + Tailwind 3 (JS only, paths.base=/mathmax) - Vietnamese landing page: hero + scope (lớp 6-9) + 3 topic cards (Số học, Đại số, Hình học) all "Sắp ra mắt" - GitHub Actions: CI (build) on PR + deploy to Pages on main - Apache-2.0 LICENSE, README, RUNBOOK, CHANGELOG diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..0b91b35 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,28 @@ +name: CI + +on: + pull_request: + push: + branches: + - main + +permissions: + contents: read + +jobs: + ci: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-node@v4 + with: + node-version: '24' + # TODO: add `cache: 'npm'` once package-lock.json is committed. + + - name: Install dependencies + # TODO: switch to `npm ci` once package-lock.json is committed. + run: npm install --no-audit --no-fund + + - name: Build + run: npm run build diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..33946a5 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,53 @@ +name: Deploy to GitHub Pages + +on: + push: + branches: + - main + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages-deploy + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-node@v4 + with: + node-version: '24' + # TODO: add `cache: 'npm'` once package-lock.json is committed. + + - name: Install dependencies + # TODO: switch to `npm ci` once package-lock.json is committed. + run: npm install --no-audit --no-fund + + - name: Build + run: npm run build + env: + SITE_URL: https://tiennm99.github.io + SITE_BASE: /mathmax + + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./build + + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..38b3e49 --- /dev/null +++ b/.gitignore @@ -0,0 +1,27 @@ +# SvelteKit build output +.svelte-kit/ +build/ + +# dependencies +node_modules/ + +# environment variables +.env +.env.* +!.env.example + +# macOS +.DS_Store + +# editor +.vscode/ +.idea/ + +# logs +npm-debug.log* +yarn-debug.log* +pnpm-debug.log* + +# tooling +*.tsbuildinfo +.eslintcache diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9e5b597 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Changelog + +All notable changes to **MathMax** are documented here. Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Versioning: 4-digit MAJOR.MINOR.PATCH.MICRO. + +## [Unreleased] + +## [0.0.1.0] - 2026-04-30 + +### Added + +- Initial SvelteKit + Tailwind scaffold (JS only, `paths.base = '/mathmax'`, `@sveltejs/adapter-static`). +- Vietnamese landing page: hero, scope chips (lớp 6-9), three topic cards (Số học / Đại số / Hình học) all "Sắp ra mắt". +- Apache-2.0 LICENSE, README, RUNBOOK. +- GitHub Actions: CI (build) on PR, deploy to GitHub Pages on `main`. +- Public repo `github.com/tiennm99/mathmax` w/ topics + Pages enabled (workflow build_type). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..540b062 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 2026 tiennm99 + + 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/README.md b/README.md new file mode 100644 index 0000000..60e02d1 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# MathMax + +Toán tương tác cho học sinh THCS Việt Nam (lớp 6-9). Số học, Đại số, Hình học qua kéo-thả và minh hoạ trực quan. + +## Status + +Scaffold only (v0.0.1.0). Landing page liệt kê 3 chủ đề với "Sắp ra mắt". Modules tương tác sẽ ra mắt từng phần. + +## Develop + +Yêu cầu: Node 24+, npm 11+. + +```sh +npm install +npm run dev # http://localhost:5173/mathmax/ +npm run build # Static output → build/ +npm run preview # Serve build/ +``` + +## Deploy + +Auto-deploy lên GitHub Pages từ `main` qua `actions/deploy-pages@v4`. Xem `RUNBOOK.md` để rollback / chuyển domain. + +Live URL: https://tiennm99.github.io/mathmax/ + +## Architecture + +- **Static**: SvelteKit + `@sveltejs/adapter-static`, `paths.base = '/mathmax'`, output `build/`. +- **Styling**: Tailwind 3 (PostCSS), system font stack (Be Vietnam Pro sẽ thêm khi có module đầu tiên). +- **Language**: JavaScript only (Svelte 5, JSDoc qua `jsconfig.json`). +- **i18n**: Hiện chỉ có tiếng Việt. English thêm khi cần. + +## License + +Apache-2.0. Xem `LICENSE`. diff --git a/RUNBOOK.md b/RUNBOOK.md new file mode 100644 index 0000000..8e8d7c7 --- /dev/null +++ b/RUNBOOK.md @@ -0,0 +1,57 @@ +# Runbook — MathMax + +## Deployment + +Production deploys from `main` via GitHub Actions (`.github/workflows/deploy.yml`). + +- Live URL: `https://tiennm99.github.io/mathmax/` +- Build: `npm run build` (SvelteKit static, output to `build/`) +- Deploy mechanism: `actions/upload-pages-artifact@v3` + `actions/deploy-pages@v4` +- Concurrency: `pages-deploy` group, cancel-in-progress disabled (so a force-pushed retry doesn't abort an in-flight rollback) + +## Rollback + +GitHub Pages keeps the last successful deployment. To roll back: + +1. Find the offending commit on `main`: `git log --oneline main` +2. Revert it: `git revert ` and push to `main` +3. The next workflow run rebuilds and re-deploys the prior good state +4. Verify the live site + +If the workflow itself is broken (e.g., bad `deploy.yml` change), use the GitHub UI to re-run a previous successful deployment from the **Deployments** tab. + +## CI + +- `.github/workflows/ci.yml` runs build on every PR and push to `main`. Build failure on `main` blocks the deploy job. +- Local equivalent: `npm install && npm run build` + +## Domain migration trigger + +Per plan, buy a `.vn` / `.com.vn` domain only when ANY of: + +1. **500 unique sessions** in any rolling 30-day window post-launch, OR +2. **1 organic teacher share** (Facebook group, Zalo, or school chat — verified, not founder-initiated), OR +3. **≥5 modules shipped** (signals content sustainability and amortizes the domain cost) + +If none hit within 90 days of soft launch, stay on `tiennm99.github.io/mathmax/`. + +When the trigger fires: + +1. Register the domain (VN registration: passport scan + address proof + MIC filing, 7–14 days) +2. Add `CNAME` file at repo root with the new domain (e.g. `mathmax.vn`) +3. Configure custom domain in GitHub Pages settings (Settings → Pages → Custom domain) +4. Update `svelte.config.js`: change `paths.base` from `/mathmax` to `/`, update any hardcoded references. Or update the workflow `env:` block. +5. Update OpenGraph + canonical URLs (handled automatically once `svelte.config.js` reflects the new domain) +6. Wait 24h, then update sitemap submission in Google Search Console +7. Set up 301 redirects (GitHub Pages handles this automatically once the custom domain is the primary) + +## Things to NOT do + +- Never `git push --force` to `main`. +- Never edit `VERSION` or `package.json.version` independently — they must agree. +- Never change `svelte.config.js` `paths.base` without simultaneously updating the deploy workflow `env:` and any hardcoded internal links. +- Never run `npm install` in CI without committing the resulting `package-lock.json` locally first. + +## Initial CI note + +Initial CI uses `npm install` (no lockfile committed yet). After first successful run, user commits `package-lock.json` locally and we switch CI to `npm ci` in a follow-up PR. diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..0866607 --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +0.0.1.0 diff --git a/jsconfig.json b/jsconfig.json new file mode 100644 index 0000000..3e24382 --- /dev/null +++ b/jsconfig.json @@ -0,0 +1,14 @@ +{ + "compilerOptions": { + "moduleResolution": "bundler", + "target": "ESNext", + "module": "ESNext", + "checkJs": true, + "allowJs": true, + "paths": { + "$lib": ["src/lib"], + "$lib/*": ["src/lib/*"] + } + }, + "include": ["src/**/*", ".svelte-kit/ambient.d.ts", ".svelte-kit/types/**/$types.d.ts"] +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..bf64c8f --- /dev/null +++ b/package.json @@ -0,0 +1,29 @@ +{ + "name": "mathmax", + "version": "0.0.1.0", + "private": true, + "type": "module", + "description": "MathMax — Toán tương tác cho học sinh THCS lớp 6-9. Static site.", + "scripts": { + "dev": "vite dev", + "build": "vite build", + "preview": "vite preview", + "check": "svelte-check --tsconfig ./jsconfig.json", + "format": "prettier --write ." + }, + "dependencies": { + "@sveltejs/adapter-static": "^3.0.8", + "@sveltejs/kit": "^2.5.0", + "@sveltejs/vite-plugin-svelte": "^4.0.0", + "svelte": "^5.0.0", + "vite": "^5.4.0", + "tailwindcss": "^3.4.0", + "autoprefixer": "^10.4.0", + "postcss": "^8.4.0" + }, + "devDependencies": { + "svelte-check": "^4.0.0", + "prettier": "^3.3.0", + "prettier-plugin-svelte": "^3.2.0" + } +} diff --git a/postcss.config.js b/postcss.config.js new file mode 100644 index 0000000..2aa7205 --- /dev/null +++ b/postcss.config.js @@ -0,0 +1,6 @@ +export default { + plugins: { + tailwindcss: {}, + autoprefixer: {}, + }, +}; diff --git a/src/app.css b/src/app.css new file mode 100644 index 0000000..7a43db1 --- /dev/null +++ b/src/app.css @@ -0,0 +1,15 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; + +@layer base { + *, + *::before, + *::after { + box-sizing: border-box; + } + + html { + -webkit-text-size-adjust: 100%; + } +} diff --git a/src/app.html b/src/app.html new file mode 100644 index 0000000..035fafa --- /dev/null +++ b/src/app.html @@ -0,0 +1,12 @@ + + + + + + + %sveltekit.head% + + +
%sveltekit.body%
+ + diff --git a/src/routes/+layout.js b/src/routes/+layout.js new file mode 100644 index 0000000..ba58d86 --- /dev/null +++ b/src/routes/+layout.js @@ -0,0 +1,2 @@ +export const prerender = true; +export const trailingSlash = 'always'; diff --git a/src/routes/+layout.svelte b/src/routes/+layout.svelte new file mode 100644 index 0000000..3c1606a --- /dev/null +++ b/src/routes/+layout.svelte @@ -0,0 +1,7 @@ + + +{@render children()} diff --git a/src/routes/+page.svelte b/src/routes/+page.svelte new file mode 100644 index 0000000..9ce4d52 --- /dev/null +++ b/src/routes/+page.svelte @@ -0,0 +1,125 @@ + + MathMax — Toán cho học sinh THCS + + + + +
+
+ MathMax + + +
+
+ + +
+
+

MathMax

+

+ Toán tương tác cho học sinh THCS — lớp 6 đến lớp 9. Khám phá Số học, Đại số, Hình học qua các hoạt động kéo-thả, thử nghiệm, và minh hoạ trực quan. +

+ + +
+ Phạm vi +
    +
  • + Lớp 6 +
    • +
  • + Lớp 7 +
    • +
  • + Lớp 8 +
    • +
  • + Lớp 9 +
    • +
+
+
+ + +
+

Chủ đề

+
    + + +
  • +
    +

    Số học

    + + Sắp ra mắt + +
    +

    + Phép tính, ước-bội, phân số, số nguyên. Trực quan hoá thuật toán và quy luật. +

    +
    • + + +
  • +
    +

    Đại số

    + + Sắp ra mắt + +
    +

    + Biểu thức, phương trình, hàm số. Thao tác kéo-thả các đối tượng đại số. +

    +
    • + + +
  • +
    +

    Hình học

    + + Sắp ra mắt + +
    +

    + Tam giác, tứ giác, đường tròn. Kéo điểm, định lý sống động. +

    +
    • + +
+
+
+ + + diff --git a/static/favicon.svg b/static/favicon.svg new file mode 100644 index 0000000..4decdf4 --- /dev/null +++ b/static/favicon.svg @@ -0,0 +1,5 @@ + + + M + diff --git a/svelte.config.js b/svelte.config.js new file mode 100644 index 0000000..420be0e --- /dev/null +++ b/svelte.config.js @@ -0,0 +1,15 @@ +import adapter from '@sveltejs/adapter-static'; +import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'; + +const base = process.env.SITE_BASE ?? '/mathmax'; + +/** @type {import('@sveltejs/kit').Config} */ +const config = { + preprocess: vitePreprocess(), + kit: { + adapter: adapter({ fallback: 'index.html' }), + paths: { base }, + }, +}; + +export default config; diff --git a/tailwind.config.js b/tailwind.config.js new file mode 100644 index 0000000..4068a90 --- /dev/null +++ b/tailwind.config.js @@ -0,0 +1,12 @@ +/** @type {import('tailwindcss').Config} */ +export default { + content: ['./src/**/*.{html,js,svelte}'], + theme: { + extend: { + fontFamily: { + sans: ['system-ui', 'sans-serif'], + }, + }, + }, + plugins: [], +}; diff --git a/vite.config.js b/vite.config.js new file mode 100644 index 0000000..2e920e4 --- /dev/null +++ b/vite.config.js @@ -0,0 +1,6 @@ +import { sveltekit } from '@sveltejs/kit/vite'; +import { defineConfig } from 'vite'; + +export default defineConfig({ + plugins: [sveltekit()], +});