# AeThex OS > A modular web desktop platform and bootable Linux distribution built with TypeScript, React, Vite, Drizzle ORM, and Supabase. [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)]() [![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue.svg)](https://aethex-corporation.github.io/AeThex-OS/) --- ## ๐ŸŒ What is AeThex OS? **AeThex OS** is a multi-deployment platform that works as: - ๐ŸŒ **Web Application** - Browser-based CloudOS hosted on Railway - ๐Ÿ’ป **Desktop Application** - Native Tauri app (Windows/Mac/Linux) - ๐Ÿ“ฑ **Mobile Application** - Capacitor-based app (Android/iOS) - ๐Ÿง **Linux Distribution** - Bootable OS replacing traditional operating systems ## ๐Ÿ“ฅ Downloads ### Desktop Application - **[Download for Windows, macOS, or Linux](https://github.com/AeThex-Corporation/AeThex-OS/releases/latest)** - Latest desktop releases - **[All Releases](https://github.com/AeThex-Corporation/AeThex-OS/releases)** - View all versions ### Web Application - **[Use Online](https://aethex.app)** - No installation required ## ๐Ÿš€ Quick Start Choose your deployment mode: ### Web (Browser-Based) ```bash npm install npm run dev # Visit http://localhost:5173 ``` ### Desktop (Tauri) ```bash npm install npm run tauri dev ``` ### Mobile (Capacitor) ```bash npm install npm run build npx cap sync android npx cap open android ``` ### Linux OS (Bootable ISO) ```bash sudo bash script/build-linux-iso.sh # Flash to USB: sudo dd if=aethex-linux.iso of=/dev/sdX bs=4M ``` ## ๐Ÿ“š Documentation ๐Ÿ“– **[Full Documentation on GitHub Pages](https://aethex-corporation.github.io/AeThex-OS/)** ### Quick Links #### Getting Started - [Linux Quick Start](https://aethex-corporation.github.io/AeThex-OS/docs/linux-quickstart) - Build and deploy AeThex Linux - [Desktop/Mobile Setup](https://aethex-corporation.github.io/AeThex-OS/docs/desktop-mobile-setup) - Tauri and Capacitor configuration - [Web vs Desktop Guide](https://aethex-corporation.github.io/AeThex-OS/docs/web-vs-desktop) - Understanding deployment modes #### Core Specifications - [**AeThex OS Specification**](https://aethex-corporation.github.io/AeThex-OS/docs/os-specification) - Official OS architecture and design document - [AeThex Linux Overview](https://aethex-corporation.github.io/AeThex-OS/docs/aethex-linux) - Bootable Linux distribution details - [Platform UI Guide](https://aethex-corporation.github.io/AeThex-OS/docs/platform-ui-guide) - Adaptive UI design #### Authentication & Security - [OAuth Quick Start](https://aethex-corporation.github.io/AeThex-OS/docs/oauth-quickstart) - 5-minute OAuth setup - [OAuth Implementation](https://aethex-corporation.github.io/AeThex-OS/docs/oauth-implementation) - Technical details - [Credentials Rotation](https://aethex-corporation.github.io/AeThex-OS/docs/credentials-rotation) - Security best practices #### Build & Deploy - [ISO Build Guide](https://aethex-corporation.github.io/AeThex-OS/docs/iso-build-fixed) - Complete Linux ISO build process - [GitLab CI Setup](https://aethex-corporation.github.io/AeThex-OS/docs/gitlab-ci-setup) - Automated builds - [Flash USB Guide](https://aethex-corporation.github.io/AeThex-OS/docs/flash-usb) - Create bootable USB drives ## ๐Ÿ—๏ธ Architecture ``` โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚ AeThex Platform (Multi-Mode) โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค โ”‚ Web Desktop Mobile Linux OS โ”‚ โ”‚ (Vite) (Tauri) (Capacitor) (Ubuntu) โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ†“ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚ React + TypeScript Frontend โ”‚ โ”‚ โ€ข Desktop UI โ€ข File Manager โ€ข Terminal โ”‚ โ”‚ โ€ข Apps โ€ข Marketplace โ€ข Messaging โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ†“ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚ Node.js + Express Backend โ”‚ โ”‚ โ€ข API Routes โ€ข WebSocket โ€ข Storage โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ†“ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚ Supabase (PostgreSQL + Auth) โ”‚ โ”‚ โ€ข Drizzle ORM โ€ข Multi-tenancy โ€ข OAuth โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ ``` ## ๐Ÿ› ๏ธ Technology Stack | Layer | Technologies | |-------|-------------| | **Frontend** | React, TypeScript, Vite, TailwindCSS, Shadcn/ui | | **Backend** | Node.js, Express, WebSocket | | **Database** | PostgreSQL (Supabase), Drizzle ORM | | **Authentication** | Supabase Auth, OAuth 2.0 (Discord, GitHub, Roblox) | | **Desktop** | Tauri (Rust + WebView) | | **Mobile** | Capacitor, Cordova | | **Linux OS** | Ubuntu 24.04 LTS, Xfce, systemd | ## ๐Ÿ“ฆ Project Structure ``` AeThex-OS/ โ”œโ”€โ”€ client/ # React frontend application โ”œโ”€โ”€ server/ # Node.js backend API โ”œโ”€โ”€ shared/ # Shared schema and types (Drizzle) โ”œโ”€โ”€ migrations/ # Database migrations โ”œโ”€โ”€ docs/ # Documentation (GitHub Pages) โ”œโ”€โ”€ os/ # Linux OS-specific files โ”œโ”€โ”€ configs/ # System configurations (GRUB, systemd) โ”œโ”€โ”€ script/ # Build and deployment scripts โ”œโ”€โ”€ android/ # Capacitor Android project โ”œโ”€โ”€ ios/ # Capacitor iOS project โ””โ”€โ”€ src-tauri/ # Tauri desktop application ``` ## ๐Ÿงช Development ### Prerequisites - Node.js 20.x or higher - npm or yarn - PostgreSQL (or Supabase account) - For Linux builds: Ubuntu 24.04 or Docker ### Environment Setup ```bash # Clone repository git clone https://github.com/AeThex-Corporation/AeThex-OS.git cd AeThex-OS # Install dependencies npm install # Copy environment template cp .env.example .env # Configure Supabase credentials in .env # VITE_SUPABASE_URL=your_supabase_url # VITE_SUPABASE_ANON_KEY=your_anon_key # Run database migrations npm run db:push # Start development server npm run dev ``` ### Testing ```bash # Run test suite ./test-implementation.sh # Build for production npm run build # Preview production build npm run preview ``` ## ๐ŸŽฏ Features ### Platform Features - โœ… Multi-tenant architecture with organization support - โœ… OAuth authentication (Discord, GitHub, Roblox) - โœ… Desktop environment with window management - โœ… File manager with upload/download - โœ… Terminal emulator (xterm.js) - โœ… Real-time messaging and chat - โœ… Application marketplace - โœ… Achievement system - โœ… User profiles and settings ### Linux OS Features - โœ… Live USB boot with persistence - โœ… Xfce desktop environment - โœ… Auto-login and kiosk mode - โœ… Pre-installed AeThex applications - โœ… NetworkManager for WiFi/Ethernet - โœ… systemd service management - ๐Ÿ”„ Secure boot support (planned) - ๐Ÿ”„ Disk encryption (planned) - ๐Ÿ”„ OTA updates (planned) ## ๐Ÿค Contributing We welcome contributions! Please see our contributing guidelines: 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/amazing-feature`) 3. Commit your changes (`git commit -m 'Add amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request ## ๐Ÿ“„ License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ## ๐Ÿ”— Links - **Documentation:** https://aethex-corporation.github.io/AeThex-OS/ - **Repository:** https://github.com/AeThex-Corporation/AeThex-OS - **Issues:** https://github.com/AeThex-Corporation/AeThex-OS/issues - **Discord:** [Join our community](#) *(coming soon)* ## ๐Ÿ™ Acknowledgments - Built on [Ubuntu 24.04 LTS](https://ubuntu.com/) - Desktop framework: [Tauri](https://tauri.app/) - Mobile framework: [Capacitor](https://capacitorjs.com/) - Database: [Supabase](https://supabase.com/) - UI Components: [Shadcn/ui](https://ui.shadcn.com/) --- **AeThex OS** - *Where cloud meets desktop meets operating system* Made with โค๏ธ by the AeThex Corporation team