70 lines
3.6 KiB
Markdown
70 lines
3.6 KiB
Markdown
# VNOX — Web
|
|
|
|
> Public project website and account frontend for VNOX Central.
|
|
|
|
[](LICENSE)
|
|
[](https://nodejs.org/)
|
|
|
|
---
|
|
|
|
## What is this?
|
|
|
|
A lightweight, self-hosted website for VNOX, a Rust voice and text communication platform. This is a separate repository from [VNOX Client](https://git.wihuk.pro/boba/VNOX-Client) and [VNOX Server](https://git.wihuk.pro/boba/VNOX-Server).
|
|
|
|
The site uses plain HTML, CSS and JavaScript modules. There are **no runtime or build dependencies**, third-party scripts, analytics or external fonts.
|
|
|
|
## Features
|
|
|
|
- Responsive Russian/English project pages with the approved VNOX mark.
|
|
- Interactive, clearly labelled layout illustration and a real native-client screenshot.
|
|
- Account loading, signed-out, signed-in, unavailable and sign-out states.
|
|
- GitHub sign-in through VNOX Hub, same-origin cookies and CSRF-protected sign-out.
|
|
- Explicit early-development status; no invented releases, people or download links.
|
|
|
|
The website does not implement identity verification itself. The Rust Hub exchanges GitHub credentials and manages sessions. Central accounts are not yet linked to the desktop client's local cryptographic identity.
|
|
|
|
## Development
|
|
|
|
Requires Node.js 22 or newer. No `npm install` is needed.
|
|
|
|
```sh
|
|
npm run dev # Local preview at http://127.0.0.1:4176
|
|
npm test # Node tests: locale parity, API/security and preview routing
|
|
npm run build # Copy public/ and src/ into dist/, normalize permissions
|
|
npm run preview # Preview the built dist/ directory
|
|
```
|
|
|
|
Optional browser QA: `python3 tests/browser_qa.py` uses an existing local Playwright installation and Chromium against the running preview. It does not add a project dependency.
|
|
|
|
Set `PORT=4180` to change the preview port. The preview intentionally returns HTTP 503 for API requests; it contains no fake backend or development credentials.
|
|
|
|
## Structure
|
|
|
|
```text
|
|
public/ HTML entry point and self-hosted assets
|
|
src/ Application, API helpers, RU/EN catalogs and styling
|
|
scripts/ Dependency-free build and loopback preview
|
|
tests/ Node regression tests
|
|
docs/ Design direction and Nginx integration example
|
|
```
|
|
|
|
## Hub integration
|
|
|
|
Serve `dist/` at the same HTTPS origin as VNOX Hub. `/` and `/account` use `index.html`; preserve proxy routes `/v1/`, `/health`, `/ready` and `/version`. See [Nginx example](docs/nginx-static.conf).
|
|
|
|
| Endpoint | Frontend behaviour |
|
|
| --- | --- |
|
|
| `GET /v1/info` | Enable sign-in only when `capabilities.github_auth` is `enabled` |
|
|
| `GET /v1/auth/github/start` | Browser navigation to GitHub authorization |
|
|
| `GET /v1/auth/session` | Load `authenticated`, public `user` and ephemeral `csrf_token` |
|
|
| `POST /v1/auth/logout` | Send `X-CSRF-Token`; clear the account after success |
|
|
|
|
The Hub sets Secure, HttpOnly cookies. Tokens are never stored in browser storage; only the preferred UI language is persisted. Keep OAuth callback query strings out of reverse-proxy access and error logs. Never place secrets or `.env` files in the static release.
|
|
|
|
## Contributing
|
|
|
|
Keep RU/EN catalog keys aligned, render profile values as text and retain keyboard navigation and reduced-motion support. Use descriptive Conventional Commits such as `fix(web): preserve account state when changing language`. Run tests and build before submitting a focused PR; include screenshots for visual changes. See [verification notes](docs/verification.md) for browser QA and current limits.
|
|
|
|
## License
|
|
|
|
GNU GPL version 3. See [LICENSE](LICENSE).
|