Veyla

Veyla is a native Android workspace browser focused on organized, private, and reliable web browsing.

---

✨ Features

Feature	Description
Multi-tab browsing	Open and manage multiple websites with independent tabs
Workspaces	Organize browser activity into named workspaces
Bookmarks	Save and manage frequently used websites
Password Manager Integration	Use compatible Android credential/autofill providers such as Bitwarden
Biometric Lock	Protect Veyla with Android biometric authentication
Ad Blocking	Block known ad/tracker hosts
Session Restore	Restore supported previous browser state without exposing a user-facing Sessions collection feature

---

🚀 Getting Started

Prerequisites

• JDK 21
• Android SDK API 36
• Android Studio or compatible Gradle environment
• Android device/emulator running Android 10 or later

Installation

git clone https://github.com/Pratham2511/Veyla.git
cd Veyla/android
./gradlew assembleDebug

Quick Start

1. Build the application.
2. Install the generated APK on an Android device or emulator.
3. Launch Veyla and complete onboarding.
4. Create a workspace and begin browsing.

---

📖 Usage

Basic Usage

Open Veyla, enter a URL or search query in the browser field, and use the tab/workspace controls to organize browsing.

Commands

Command	Description
./gradlew assembleDebug	Build the debug APK
./gradlew testDebugUnitTest	Run unit tests
./gradlew lintDebug	Run Android lint

---

🔧 Configuration

Setting	Description	Default
Appearance	Controls light/dark/system theme	System
Search engine	Controls default search provider	Configured during onboarding
JavaScript	Enables JavaScript for new browser tabs	Enabled
Ad blocking	Enables host-based ad/tracker blocking	Enabled
Biometric lock	Protects Veyla using Android biometrics	Disabled
Auto restore	Restores supported previous browser state	Configured by user

Example configuration:

{
  "appearance": "system",
  "javascript": true,
  "adBlocking": true,
  "biometricLock": false,
  "autoRestore": true
}

---

🛠️ Development

Setup

git clone https://github.com/Pratham2511/Veyla.git
cd Veyla/android

Build

./gradlew assembleDebug

Run

Install the generated APK on an Android device or emulator.

Test

./gradlew testDebugUnitTest
./gradlew lintDebug

---

🤝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details.

---

📜 License

This project is MIT licensed.

---

🙌 Acknowledgments

Built with Kotlin, Jetpack Compose, Android WebView, Room, Hilt, and Material 3.