README.md (1731B)
1 # Veyrix IDE 2 3 Veyrix IDE is a lightweight, privacy-first, Progressive Web App (PWA) code editor that runs entirely in the browser. It features local IndexedDB storage, offline capabilities, real-time syntax highlighting, and dual sharing mechanics. Built for developers who need a fast, zero-setup scratchpad. 4 5 ## Features 6 7 * In-Browser Execution: No server setup required. Everything runs locally. 8 * Local Storage: Files are saved securely in your browser's IndexedDB. 9 * Offline Support: Install as a PWA and use it completely offline. 10 * Snapshot System: Save up to 5 versioned snapshots per file to track your progress. 11 * Dual Sharing Mechanics: 12 * Fast Local Share: Compresses code directly into a URL using LZ-String. No servers involved. 13 * Cloud Share: Generates short links by uploading to an anonymous Firebase Firestore instance. Includes optional password protection. 14 * Native Web Share Integration: Share code directly to mobile apps or desktop environments. 15 16 ## Getting Started 17 18 Visit the live site to start using Veyrix IDE immediately. No installation is required. 19 To install as a PWA, click the "Settings" icon and select "Install Web App". 20 21 ## Architecture 22 23 * UI/Styling: Tailwind CSS 24 * Editor: Ace Editor 25 * Compression: LZ-String 26 * Cloud Sharing: Firebase (Firestore, Anonymous Auth) 27 28 ## Support and Contact 29 30 For general inquiries: mail@amit.is-a.dev 31 For important matters: amitdutta4255@gmail.com 32 Developer Portfolio: https://amit.is-a.dev 33 34 ## Disclaimer 35 36 Use of this tool is at your own risk. The creator is not responsible for any data loss, misuse, or damages caused by using this application. The creator holds full rights to modify or permanently discontinue this project at any time without prior notice.