VSCode Android

A production-ready VS Code-like Android application built with Tauri v2, featuring real-time GitHub Codespaces synchronization for lag-free mobile coding.

Features

Core Editor

📝 Monaco Editor - Full VS Code editor experience with IntelliSense, syntax highlighting, and multi-cursor editing
🎨 VS Code Theming - Dark/Light themes matching VS Code's appearance
📑 Tab Management - Multiple file tabs with dirty state tracking
⌨️ Keyboard Shortcuts - VS Code-compatible shortcuts adapted for mobile

GitHub Codespaces Integration

🔐 GitHub OAuth - Secure authentication with token storage
🖥️ Codespace Management - List, start, stop, and connect to Codespaces
🔄 Real-time Sync - Bidirectional sync between local editor and remote Codespace
📡 WebSocket Proxy - Terminal and debugger output from Codespace

Sync System

⚡ Debounced Auto-sync - Changes sync 300ms after typing stops
📴 Offline Mode - Full editing capability without network
🔄 Sync Queue - Pending changes queue for offline edits
⚖️ Conflict Resolution - Smart merge with last-write-wins fallback

Mobile Optimizations

👆 Touch-friendly UI - 44px minimum touch targets
📱 Responsive Layout - Adapts to all screen sizes
🔄 Gesture Support - Swipe navigation, pull-to-refresh
📲 Fullscreen Mode - Distraction-free coding

Architecture

graph TB
    subgraph Frontend ["React Frontend"]
        A[Monaco Editor]
        B[UI Components]
        C[State Management - Jotai]
        D[Command Palette]
    end
    
    subgraph Tauri ["Tauri Rust Backend"]
        E[API Commands]
        F[Sync Engine]
        G[Conflict Resolver]
        H[WebSocket Handler]
    end
    
    subgraph External ["External Services"]
        I[GitHub OAuth]
        J[Codespaces API]
        K[Codespace WebSocket]
    end
    
    A --> C
    B --> C
    D --> C
    C --> E
    E --> F
    F --> G
    F --> H
    E --> I
    E --> J
    H --> K

Tech Stack

Layer	Technology
Framework	Tauri v2 (Android)
Frontend	React 18 + TypeScript
Build	Vite
Styling	Tailwind CSS
State	Jotai
Editor	Monaco Editor
Terminal	xterm.js
Backend	Rust
HTTP	reqwest
WebSocket	tungstenite
Diff	diffy

Project Structure

vscode-android/
├── src/                    # React frontend
│   ├── components/         # UI components
│   │   ├── ActivityBar.tsx
│   │   ├── AuthScreen.tsx
│   │   ├── CodespaceSelector.tsx
│   │   ├── CommandPalette.tsx
│   │   ├── EditorArea.tsx
│   │   ├── MainLayout.tsx
│   │   ├── SideBar.tsx
│   │   ├── SplashScreen.tsx
│   │   ├── StatusBar.tsx
│   │   └── TerminalPanel.tsx
│   ├── hooks/              # Custom React hooks
│   │   ├── useAuth.ts
│   │   ├── useCodespaces.ts
│   │   ├── useEditor.ts
│   │   └── useSync.ts
│   ├── lib/                # Utilities
│   │   └── utils.ts
│   ├── store/              # State management
│   ├── test/               # Test setup
│   ├── types/              # TypeScript types
│   │   └── index.ts
│   ├── App.tsx
│   ├── index.css
│   └── main.tsx
├── src-tauri/              # Rust backend
│   ├── src/
│   │   ├── codespaces.rs   # Codespaces API
│   │   ├── commands.rs     # Tauri commands
│   │   ├── conflict.rs     # Conflict resolution
│   │   ├── github.rs       # GitHub OAuth
│   │   ├── lib.rs          # Main entry
│   │   ├── sync.rs         # Sync engine
│   │   └── types.rs        # Rust types
│   ├── Cargo.toml
│   └── tauri.conf.json
├── e2e/                    # E2E tests
├── package.json
├── tailwind.config.js
├── tsconfig.json
└── vite.config.ts

Getting Started

Prerequisites

Rust (1.70+)

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Node.js (18+)
```
# Using nvm
nvm install 18
nvm use 18
```
Android Studio with:
- Android SDK (API 24+)
- Android NDK
- CMake
Tauri CLI
```
cargo install tauri-cli
```
GitHub OAuth App
- Create at https://github.com/settings/developers
- Set callback URL to your app's custom scheme

Installation

# Clone the repository
git clone https://github.com/your-org/vscode-android.git
cd vscode-android

# Install dependencies
npm install

# Set environment variables
export GITHUB_CLIENT_ID="your_client_id"
export GITHUB_CLIENT_SECRET="your_client_secret"

Development

# Run in development mode (desktop)
npm run tauri dev

# Run on Android device
npm run tauri:android:dev

# Build APK
npm run tauri:android:apk

# Build AAB for Play Store
npm run tauri:android:aab

Testing

# Unit tests
npm run test

# E2E tests
npm run test:e2e

# Lint
npm run lint

Configuration

GitHub OAuth Setup

Go to GitHub Developer Settings
Create new OAuth App
Set Authorization callback URL to vscode-android://oauth/callback
Copy Client ID and Secret
Update src-tauri/src/github.rs with your credentials

Android Signing

For production builds, configure signing in tauri.conf.json:

{
  "bundle": {
    "android": {
      "keystorePath": "/path/to/keystore.jks",
      "keystorePassword": "your_password",
      "keyPassword": "your_key_password",
      "keyAlias": "your_alias"
    }
  }
}

Keyboard Shortcuts

Shortcut	Action
Ctrl+Shift+P	Command Palette
Ctrl+B	Toggle Sidebar
Ctrl+S	Save File
Ctrl+P	Quick Open
Ctrl+F	Find
Ctrl+H	Replace
Ctrl+`	Toggle Terminal
Esc	Close Panels

API Reference

Tauri Commands

Authentication

github_login() - Initiate OAuth flow
github_callback(code, state) - Handle OAuth callback
get_github_user() - Get current user
logout() - Clear auth tokens

Codespaces

list_codespaces() - List all codespaces
get_codespace(name) - Get codespace details
start_codespace(name) - Start a codespace
stop_codespace(name) - Stop a codespace
create_codespace(repo, options) - Create new codespace

Sync

sync_file_to_codespace(path, content) - Push file changes
sync_file_from_codespace(path) - Pull file from remote
push_all_changes() - Flush pending changes
pull_all_changes() - Pull remote changes
get_sync_status() - Get current sync status

Security

🔒 Tokens stored in encrypted Tauri Store
🔐 OAuth state verification (CSRF protection)
🛡️ CSP headers configured
🔑 No plaintext secrets in code

Privacy

All code editing happens locally
Tokens never leave the device
No telemetry by default
Open source and auditable

Troubleshooting

Build Issues

Problem: cargo build fails with linker errors

# Solution: Install Android NDK and set environment
export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/<version>

Problem: Gradle sync fails

# Solution: Clean and rebuild
cd src-tauri
cargo clean
cd ..
npm run tauri:android:build

Runtime Issues

Problem: OAuth callback not working

Ensure custom URL scheme is registered in AndroidManifest.xml
Verify callback URL matches GitHub OAuth app settings

Problem: Sync not working

Check network connectivity
Verify GitHub token has codespace scope
Check Codespace is in available or running state

Contributing

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

License

MIT License - see LICENSE for details.

Acknowledgments

Tauri - Cross-platform framework
Monaco Editor - Code editor
GitHub Codespaces - Cloud development
xterm.js - Terminal emulator

Roadmap

License

See LICENSE for details.

Built with ❤️ for mobile developers

CI/CD & Automated Builds

Build Status

Download Pre-built APKs

You can download test builds directly from GitHub Actions:

Go to Actions tab
Select Quick Build (Manual Trigger)
Click Run workflow (or view past runs)
Download APK from Artifacts section

Trigger a Build

Automatic (on push)

git push origin main

Manual (from GitHub)

Navigate to Actions → Quick Build
Click Run workflow
Select build type
Download APK when complete

Install Downloaded APK

# Via ADB (USB debugging required)
adb install vscode-android-debug.apk

# Or transfer to device and install directly

See BUILD_GUIDE.md for detailed instructions.

Name		Name	Last commit message	Last commit date
.github		.github
e2e		e2e
scripts		scripts
src-tauri		src-tauri
src		src
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
ANDROID_BUILD_GUIDE.md		ANDROID_BUILD_GUIDE.md
ARCHITECTURE.md		ARCHITECTURE.md
CONTRIBUTING.md		CONTRIBUTING.md
ISSUES_AND_SOLUTIONS.md		ISSUES_AND_SOLUTIONS.md
LICENSE		LICENSE
README.md		README.md
SETUP_GUIDE.md		SETUP_GUIDE.md
index.html		index.html
package-lock.json		package-lock.json
package.json		package.json
playwright.config.ts		playwright.config.ts
postcss.config.js		postcss.config.js
tailwind.config.js		tailwind.config.js
tsconfig.json		tsconfig.json
tsconfig.node.json		tsconfig.node.json
vite.config.ts		vite.config.ts
vitest.config.ts		vitest.config.ts

Latest commit

History

Folders and files

Repository files navigation

VSCode Android

Features

Core Editor

GitHub Codespaces Integration

Sync System

Mobile Optimizations

Architecture

Tech Stack

Project Structure

Getting Started

Prerequisites

Installation

Development

Testing

Configuration

GitHub OAuth Setup

Android Signing

Keyboard Shortcuts

API Reference

Tauri Commands

Authentication

Codespaces

Sync

Security

Privacy

Troubleshooting

Build Issues

Runtime Issues

Contributing

License

Acknowledgments

Roadmap

License

CI/CD & Automated Builds

Build Status

Download Pre-built APKs

Trigger a Build

Automatic (on push)

Manual (from GitHub)

Install Downloaded APK

About

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages