vibetunnel/web/README.md
Mario Zechner 5180298bb5 Clean up build system and remove unused dependencies
- Remove all Jest-related dependencies (using Vitest)
- Remove pre-commit hooks (husky, lint-staged) and related files
- Consolidate test configuration into single vitest.config.ts
- Fix build-native.js to use correct entry point (src/cli.ts)
- Add bun.lock to .gitignore (generated during native build)
- Update README.md with simplified, accurate documentation
- Make npm run build include native executable build
- Remove unused type declarations and test setup files

The build system is now minimal, clean, and consistent.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-21 17:04:52 +02:00

48 lines
No EOL
1 KiB
Markdown

# VibeTunnel Web
Web terminal interface and server for VibeTunnel.
## Quick Start
Production users: Use the pre-built VibeTunnel executable from the main app.
## Development
```bash
npm install
npm run dev # Watch mode: server + client
npm run dev:client # Watch mode: client only (for debugging server)
```
Open http://localhost:3000
### Build Commands
```bash
npm run clean # Remove build artifacts
npm run build # Build everything (including native executable)
npm run lint # Check code style
npm run lint:fix # Fix code style
npm run typecheck # Type checking
npm run test # Run all tests (unit + e2e)
npm run format # Format code
```
## Production Build
```bash
npm run build
./native/vibetunnel # Run standalone executable
```
## Architecture
See [spec.md](./spec.md) for detailed architecture documentation.
## Key Features
- Terminal sessions via node-pty
- Real-time streaming (SSE + WebSocket)
- Binary-optimized buffer updates
- Multi-session support
- File browser integration