|
| 1 | +# Acoustic Data Link |
| 2 | + |
| 3 | +A browser-based acoustic data transmission app that enables devices to transmit data to each other using only sound (speakers and microphones). |
| 4 | + |
| 5 | +**Visual Metaphor**: "Deep Space Digital Radio". The interface borrows elements from high-frequency radio dashboards and cryptography terminals, employing an immersive animated aurora background with dark, glass-morphic hardware telemetry panels, a fixed primary green accent for optimal visual contrast, and decrypted text animations. |
| 6 | + |
| 7 | +*Developed by Asmith — asmyth@duck.com* |
| 8 | + |
| 9 | +## Features (Phase 1: Frontend Architecture) |
| 10 | +- **Role Selection:** Toggle instantly between Transmitter and Receiver dashboards. |
| 11 | +- **Transmitter Dashboard:** Mock configurations for FSK encoding profiles, bitrate targets, and redundancy levels, with full aesthetic waveform telemetry. |
| 12 | +- **Receiver Dashboard:** Mock listening states, ambient audio spectrum visualization, and signal decoding console logs. |
| 13 | +- **Kinetic UI:** Smooth transitions and reactive elements via Framer Motion. |
| 14 | +- **Anti-Gravity Architecture:** Full `prefers-reduced-motion` accessibility support, API fallback override mockups, and strict React state separation. |
| 15 | + |
| 16 | +## Setup Instructions |
| 17 | + |
| 18 | +### Prerequisites |
| 19 | +- Node.js (v18+) |
| 20 | +- npm or yarn |
| 21 | + |
| 22 | +### Installation |
| 23 | +1. Clone the repository |
| 24 | +2. Install dependencies: |
| 25 | + \`\`\`bash |
| 26 | + npm install |
| 27 | + \`\`\` |
| 28 | +3. Start the development server: |
| 29 | + \`\`\`bash |
| 30 | + npm run dev |
| 31 | + \`\`\` |
| 32 | + |
| 33 | +## Deployment Guide |
| 34 | + |
| 35 | +### GitHub Pages (Automated) |
| 36 | +This repository includes a GitHub Action for deploying natively to GitHub Pages. |
| 37 | +1. Push your code to the \`main\` branch. |
| 38 | +2. In your repository settings: |
| 39 | + - Go to **Settings** > **Pages**. |
| 40 | + - Set the source to **GitHub Actions**. |
| 41 | +3. *Phase 2 Only:* Add \`VITE_API_KEY\` to your Repository Secrets if the AI summarization fallback is necessary. |
| 42 | + |
| 43 | +### Netlify Deployment |
| 44 | +1. Connect your repository to Netlify. |
| 45 | +2. The included \`netlify.toml\` handles the build command (\`npm run build\`) and SPA routing redirects automatically. |
| 46 | +3. *Phase 2 Only:* Add the \`VITE_API_KEY\` environment variable in the Netlify site settings. |
| 47 | + |
| 48 | +## API Override System |
| 49 | +To protect production stability and reduce quota exhaustion, an Override System is implemented. If the backend services experience rate-limiting (`429`) or a key expiration, the UI intercepts the error and displays a modal. |
| 50 | +Users can input their own Google SDK API keys dynamically to bypass the server limitations and continue transmitting data. |
| 51 | + |
| 52 | +--- |
| 53 | +> Note: Replace the default Vite favicon in `public/` to match the radio/acoustic transmission metaphor. |
0 commit comments