Merge pull request #119 from interscript/astro-migration

feat: migrate site to Astro 7 + Vite 8 + Tailwind 4 + Vue 3

Author: ronaldtse

.babelrc

@@ -2,25 +2,32 @@ name: build
 
 on:
   push:
+    branches: [main, astro-migration]
   pull_request:
-  repository_dispatch:
-    types: [ 'interscript/interscript' ]
+  workflow_dispatch:
 
 jobs:
   build:
-    name: Build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v7
       - name: Use Node
         uses: actions/setup-node@v7
         with:
-          node-version: '18'
-          cache: yarn
-      - name: Install NPM dependencies
+          node-version: "22"
+          cache: npm
+      - name: Clone interscript-ts (file: dependency)
         run: |
-          yarn install --frozen-lockfile
-          yarn global add asciidoctor@^2.2.4
+          git clone --depth=1 --branch feat/imf-runtime-ts https://github.com/interscript/interscript-ts.git ../interscript-ts
+          cd ../interscript-ts && npm ci && npm run build
+      - name: Install dependencies
+        run: npm ci
+      - name: Type check
+        run: npm run check
       - name: Build site
-        run: |
-          yarn adoc make
+        run: npm run build
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: site
+          path: dist

.github/workflows/build.yml

@@ -3,21 +3,14 @@ name: deploy
 on:
   push:
     branches:
-    - main
-    # - staging
-  pull_request:
+      - main
   workflow_dispatch:
-  repository_dispatch:
-    types: [ 'interscript/interscript' ]
 
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
   pages: write
   id-token: write
 
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: false
@@ -34,21 +27,21 @@ jobs:
       - name: Use Node
         uses: actions/setup-node@v7
         with:
-          node-version: '18'
-          cache: yarn
-      - name: Install NPM dependencies
+          node-version: "22"
+          cache: npm
+      - name: Clone interscript-ts (file: dependency)
         run: |
-          yarn install --frozen-lockfile
-          yarn global add asciidoctor@^2.2.4
+          git clone --depth=1 --branch feat/imf-runtime-ts https://github.com/interscript/interscript-ts.git ../interscript-ts
+          cd ../interscript-ts && npm ci && npm run build
+      - name: Install dependencies
+        run: npm ci
       - name: Build site
-        run: |
-          yarn adoc make
+        run: npm run build
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v5
         with:
           path: dist
 
-  # Deployment job
   deploy:
     environment:
       name: github-pages

.github/workflows/deploy.yml

@@ -1,10 +1,26 @@
-tmp
-artifacts
-node_modules
-dist
+# Build output
+dist/
+.astro/
+
+# Dependencies
+node_modules/
+
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
 yarn-error.log
-.idea
-public/maps/**
-!public/maps/.gitkeep
-map/*
-!map/.gitkeep
+
+# Environment
+.env
+.env.production
+
+# Editor / OS
+.DS_Store
+.idea/
+.vscode/
+*.swp
+
+# Legacy react-static (kept in _legacy-content for reference)
+test-results/
+playwright-report/

.gitignore

@@ -0,0 +1,48 @@
+# Interscript.org v2
+
+Astro 7 + Vite 8 + Tailwind 4 + Vue 3 islands. Uses `interscript-ts` for live map exploration.
+
+## Status
+
+🚧 **Under active development.** Replaces the legacy `interscript/interscript.github.io` react-static site once feature parity is reached.
+
+## Stack
+
+- **Astro 7** — static site framework
+- **Vite 8** — bundler
+- **Tailwind 4** — styling (CSS-first config via `@theme` in `src/styles/global.css`)
+- **Vue 3** — interactive islands (`@astrojs/vue`)
+- **TypeScript 5.6** — `astro check` for type safety
+
+## Development
+
+```bash
+npm ci
+npm run dev      # http://localhost:4321
+npm run build    # outputs to dist/
+npm run preview  # preview build locally
+```
+
+## Project structure
+
+```
+src/
+├── layouts/
+│   └── Base.astro          # HTML shell, nav, footer
+├── components/
+│   └── MapExplorer.vue     # Vue island: live transliteration
+├── pages/
+│   ├── index.astro         # Home
+│   ├── maps/index.astro    # Map explorer
+│   └── docs/index.astro    # Docs hub
+└── styles/
+    └── global.css          # Tailwind import + theme tokens
+```
+
+## Roadmap
+
+See [TODO.complete](https://github.com/interscript/interscript/tree/main/TODO.complete) for the migration checklist from the legacy site.
+
+## License
+
+BSD-2-Clause — Ribose Inc.

README.md

@@ -0,0 +1,77 @@
+# 03 — E2E tests for interscript.org website
+
+## Priority: P0
+
+## Problem
+The website has integration tests (Vitest) that test individual modules,
+but no browser-based E2E tests that validate the actual user experience:
+loading pages, typing in transliteration inputs, seeing output.
+
+## Solution: Playwright
+
+### Setup
+```bash
+cd interscript.org
+npm install -D @playwright/test
+npx playwright install
+```
+
+### Structure
+```
+e2e/
+  playwright.config.ts
+  home.spec.ts           # Landing page loads, CTA works
+  detect.spec.ts         # Detect panel: input → system suggestion
+  compare.spec.ts        # Compare two systems side by side
+  batch.spec.ts          # Batch transliteration
+  maps.spec.ts           # Browse maps, search, filter
+  api-docs.spec.ts       # API documentation interactive
+  worker.spec.ts         # Web Worker loads and transliterates
+```
+
+### Key Test Cases
+
+#### Worker transliteration (critical path)
+```typescript
+test("worker transliterates Ukrainian", async ({ page }) => {
+  await page.goto("/")
+  const input = page.locator("[data-testid='translit-input']")
+  const output = page.locator("[data-testid='translit-output']")
+  await input.fill("Антон")
+  await expect(output).toContainText("Anton")
+})
+```
+
+#### Map browser
+```typescript
+test("browse maps by script", async ({ page }) => {
+  await page.goto("/maps")
+  await page.click("text=Cyrillic")
+  await expect(page.locator(".map-card")).toHaveCount.greaterThan(10)
+})
+```
+
+#### API playground
+```typescript
+test("API playground returns JSON", async ({ page }) => {
+  await page.goto("/api")
+  await page.fill("[data-testid='api-input']", '{"system":"bgnpcgn-ukr-Cyrl-Latn-2019","input":"Київ"}')
+  await page.click("[data-testid='api-run']")
+  await expect(page.locator("[data-testid='api-output']")).toContainText("Kyiv")
+})
+```
+
+### CI Integration
+```yaml
+# .github/workflows/e2e.yml
+- name: Build site
+  run: npm run build
+- name: Run Playwright
+  run: npx playwright test
+- name: Upload report
+  if: always()
+  uses: actions/upload-artifact@v3
+  with:
+    name: playwright-report
+    path: playwright-report/
+```

TODO.complete/01-e2e-tests.md

@@ -0,0 +1,85 @@
+= Integration with Ruby Applications
+
+Interscript can be used as a Ruby Gem library to be integrated with other Ruby
+applications.
+
+== Gemfile
+
+You need to make sure your Gemfile contains the following lines:
+
+[source,ruby]
+----
+source "https://rubygems.org"
+
+gem "interscript", "~>2.0"
+----
+
+== Requiring
+
+In your codebase, if you don't do `Bundler.require`, you will need to add the
+following line:
+
+[source,ruby]
+----
+require "interscript"
+----
+
+== Listing all available maps
+
+To list all available maps, one must execute the following code:
+
+[source,ruby]
+----
+maps = Interscript.maps
+----
+
+`maps` will be an array containing all Interscript maps by their name.
+
+== Transliterating text
+
+To transliterate test using a given map, like `bas-rus-Cyrl-Latn-2017-bss`,
+one must execute:
+
+[source,ruby]
+----
+cache = {}
+input = "Хелло"
+output = Interscript.transliterate("bas-rus-Cyrl-Latn-2017-bss",
+                                   input,
+                                   cache)
+----
+
+You should preserve the `cache` variable for performance reasons. It is optional,
+you don't need to (but should) supply it.
+
+=== Using Ruby compiler
+
+If performance is of utmost performance for your application and you want to
+sacrifice a little bit of loading time for much better performance, you can use
+`Interscript::Compiler::Ruby` instead of `Interscript::Interpreter` (which is
+used by default).
+
+[source,ruby]
+----
+require "interscript/compiler/ruby"
+
+cache = {}
+input = "Хелло"
+output = Interscript.transliterate("bas-rus-Cyrl-Latn-2017-bss",
+                                   input,
+                                   cache,
+                                   compiler: Interscript::Compiler::Ruby)
+----
+
+=== Transliterating in reverse
+
+To reverse a given string using a map with a name of a form:
+`bas-rus-Cyrl-Latn-2017-bss`, change places for Cyrl and Latn.
+
+To reverse a given string using a map with a name of a form:
+`var-swe-Latn-Latn-2021`, append `-reverse` to its name.
+
+Please note: this only works for Ruby implementation. Other implementations
+depend on the Ruby implementation for the purpose of compilation. For those,
+you need to compile the map using the Ruby implementation, but the name has
+to be given according to the above hint.