index.md (2825B)
1 --- 2 label: Veyrix IDE 3 icon: browser 4 order: 600 5 --- 6 7 # Veyrix IDE 8 9 _v1.1.0 — Stable_ 10 11 Veyrix is a lightweight, offline-first Progressive Web App (PWA) that turns your browser into a highly responsive code editor. It's designed to run smoothly in strict or restricted browser environments, keeping all processing and storage entirely client-side with no backend server. 12 13 ## Why use it 14 15 - **Absolute privacy** — your files never leave your device; everything is saved in the browser's local IndexedDB unless you explicitly use cloud share 16 - **Blazing fast** — bypasses heavy virtual DOMs in favor of a vanilla JavaScript architecture, so it runs smoothly on low-end devices 17 - **True offline mode** — install as a PWA and write code anywhere, no internet connection required 18 - **Built-in time machine** — save snapshots of your files to instantly roll back to previous versions, no Git setup needed 19 20 ## Core technology stack 21 22 | Component | Version | Role | 23 |---|---|---| 24 | Ace Editor | v1.32.6 | Core text engine | 25 | IndexedDB | — | Local persistence layer | 26 | LZ-String | v1.5.0 | URL compression (local share) | 27 | Firebase | v11.6.1 | Cloud share (loaded on demand only) | 28 29 Veyrix bypasses Virtual DOM overhead entirely — it uses a vanilla JS monolithic state architecture paired directly with the Ace Editor engine, rather than a framework like React or Vue. 30 31 ## Getting started 32 33 Visit the live site to start using Veyrix IDE immediately — no installation required. To install as a PWA, tap the menu button and select **Install Web App**; it then runs fullscreen without browser toolbars. 34 35 ## Explore the docs 36 37 - [Usage Guide](usage-guide.md) — files, editing, snapshots, sharing 38 - [Architecture & State Management](architecture.md) — state singleton, IndexedDB schema, cloud sync strategy 39 - [Security & Threat Model](security.md) — zero-knowledge password hashing, what's and isn't protected 40 - [Veyrix Web (Multi-File IDE)](veyrix-web.md) — the separate multi-file environment, live preview engine, ZIP export 41 - [Performance & Error Handling](performance.md) — benchmarks vs. VS Code Web / CodeSandbox, failure modes 42 - [Limitations & Roadmap](roadmap.md) 43 - [FAQ](faq.md) 44 45 ## Support & contact 46 47 - General inquiries: mail@amit.is-a.dev 48 - Important matters: amitdutta4255@gmail.com 49 - Developer portfolio: [amit.is-a.dev](https://amit.is-a.dev) 50 51 ## Legal disclaimer & licensing 52 53 Veyrix IDE and its documentation are provided "as is" under the **Apache License 2.0**, without warranty of any kind, express or implied. The creator reserves the right to modify or permanently discontinue the project at any time without prior notice, is not responsible for data loss, service interruptions, or damages arising from use of the software, and places sole responsibility for local data management on the user.