What it is
Veilway is an open-source VPN platform for people on censored networks. It has a Rust core, a web panel and first-party apps. This repository holds what the panel and the apps share on screen, so they look and behave like one product.
- Design tokens as CSS variables, generated from one token file. Contrast tests check every color a background can take.
- The glass material: four layers (sheet, chrome, popover, dialog), each with a known backdrop. Solid surfaces replace the glass when the system asks for reduced transparency, or when the browser has no
backdrop-filter.
- React components and charts built on them.
- The theme validator. A theme file holds color tokens only, and it is treated as hostile input. A tint too thin for its backdrop is raised. A backdrop too bright for text is refused.
- A gallery app that shows every part in dark and light, English and Persian.
- English and Persian, with right-to-left layout, ICU plurals, Persian digits and Jalali dates.
What it holds
| Path | Package | What it is |
|---|
packages/ui | @veilway/ui | Tokens, the glass material, components, charts, the theme validator and its JSON schema, and the gallery. Its README explains the glass and its contrast rule. |
packages/i18n | @veilway/i18n | English and Persian locale packs, and helpers for direction, plurals, Persian digits and Jalali dates. No React. |
Checks and the gallery
Everything runs in containers, with named volumes for node_modules. From the repository root:
V="-v $PWD/packages:/work/packages -v veilway-i18n-nm:/work/packages/i18n/node_modules -v veilway-ui-nm:/work/packages/ui/node_modules"
docker run --rm $V -w /work/packages/i18n node:22 sh -c "npm ci && npm run check && npm test"
docker run --rm $V -w /work/packages/ui node:22 sh -c "npm ci && npm run check && npm test && npm run build"
docker run --rm $V -w /work/packages/ui -p 127.0.0.1:5173:5173 node:22 npm run dev
The last command serves the gallery at http://127.0.0.1:5173. The screenshot command needs a Playwright image. It is in packages/ui/README.md.
Design rules
CONTRIBUTING.md has the full list. These are the rules a change is most likely to break:
- A visible change comes with screenshots in dark and light, English and Persian.
- A theme file and a locale pack are hostile input. A change to the theme validator or the locale loader comes with tests that feed it bad files.
- No pill shapes, no uppercase labels above headings, no emoji, and small consistent corner radii.
- Apps never show a rating word for a connection. They show only its name, and a plain warning when it is not secure.
- No blank lines inside function bodies, double quotes, one-liners where they fit, and never a code formatter.
Status
Early. The look is approved and the checks pass. The panel and both apps, desktop and Android, use it. How much the glass blur costs in an Android WebView is not measured yet.
Repositories
Contributing and security
Questions and help with setup go to GitHub Discussions, in English or Persian. Issues are for bugs and concrete feature requests.
Read CONTRIBUTING.md first. Your first pull request asks you to sign the CLA once. Report vulnerabilities privately, as described in SECURITY.md. Never report them in a public issue.
License
Apache-2.0. See LICENSE and NOTICE. The license does not cover the name. See TRADEMARKS.md.
