SilverDROID - Dark Side Admin with CI/CD pipeline
- Android PWA/WASM launcher with glassmorphism UI - Loads https://admin.dark.side directly on launch - Complete GitLab CI/CD pipeline configuration - Automated builds for Debug, Release, and AAB - Full WASM support with optimized WebView - Material Design 3 theme - Comprehensive documentation Features: - Auto-load target URL on app launch - Glassmorphism components (frosted glass effects) - Full PWA/WASM support - Room database for future extensions - Jetpack Compose UI - CI/CD with artifact storage Built for SilverLABS
This commit is contained in:
204
QUICKSTART.md
Normal file
204
QUICKSTART.md
Normal file
@@ -0,0 +1,204 @@
|
||||
# SilverDROID - Quick Start Guide
|
||||
|
||||
## 🚀 5-Minute Setup
|
||||
|
||||
### Option 1: Android Studio (Recommended)
|
||||
|
||||
1. **Open Project**
|
||||
```bash
|
||||
# From WSL
|
||||
cd /mnt/c/Production/Source/SilverLABS/SilverDROID
|
||||
```
|
||||
- Launch Android Studio
|
||||
- Click "Open"
|
||||
- Navigate to `SilverDROID` folder
|
||||
- Click "OK"
|
||||
|
||||
2. **Wait for Sync**
|
||||
- Gradle will sync automatically (~2-5 minutes first time)
|
||||
- Status shown in bottom status bar
|
||||
|
||||
3. **Run the App**
|
||||
- Click the green ▶️ (Run) button
|
||||
- Select your device/emulator
|
||||
- App will build and install
|
||||
|
||||
### Option 2: Command Line
|
||||
|
||||
```bash
|
||||
cd /mnt/c/Production/Source/SilverLABS/SilverDROID
|
||||
|
||||
# Build and install
|
||||
./gradlew installDebug
|
||||
|
||||
# Or build only
|
||||
./gradlew assembleDebug
|
||||
```
|
||||
|
||||
## 📱 First Launch
|
||||
|
||||
### What You'll See
|
||||
1. **Glassmorphism Background** - Gradient with frosted glass effect
|
||||
2. **"No Apps Yet" Screen** - Empty state with add button
|
||||
3. **+ Button** - Floating action button (bottom-right)
|
||||
|
||||
### Add Your First App
|
||||
|
||||
1. **Tap the + Button**
|
||||
2. **Enter a URL**
|
||||
- Try: `https://mobile.twitter.com`
|
||||
- Or: `https://m.youtube.com`
|
||||
- Or: `https://webassembly.org/demo/`
|
||||
3. **Tap "Add"**
|
||||
4. **See Your App** - Glass card appears in grid
|
||||
5. **Tap the Card** - Opens in full-screen WebView
|
||||
|
||||
## 🎨 What Makes It Special?
|
||||
|
||||
### Glassmorphism Effects
|
||||
- **Frosted Glass Cards** - Semi-transparent app cards
|
||||
- **Blur Effects** - Background blur on panels
|
||||
- **Gradient Background** - Animated color gradient
|
||||
- **Border Glow** - Subtle borders on glass elements
|
||||
|
||||
### PWA/WASM Features
|
||||
- **Offline Support** - Apps work without internet
|
||||
- **Service Workers** - Background sync
|
||||
- **Full-Screen Mode** - Immersive app experience
|
||||
- **WASM Execution** - Fast WebAssembly performance
|
||||
|
||||
## 🔧 Development Tips
|
||||
|
||||
### Hot Reload (Sort of)
|
||||
Compose supports limited hot reload:
|
||||
1. Make UI changes in `.kt` files
|
||||
2. Click ⚡ "Apply Changes" button
|
||||
3. Some changes apply without rebuild
|
||||
|
||||
### WebView Debugging
|
||||
1. Open Chrome on your PC
|
||||
2. Navigate to `chrome://inspect`
|
||||
3. Find "SilverDROID" under "Remote Target"
|
||||
4. Click "inspect"
|
||||
5. Full DevTools for PWA debugging!
|
||||
|
||||
### Database Inspection
|
||||
```bash
|
||||
# Pull database from device
|
||||
adb pull /data/data/uk.silverlabs.silverdroid/databases/pwa_database ./
|
||||
|
||||
# Open with SQLite browser
|
||||
sqlite3 pwa_database
|
||||
.tables
|
||||
SELECT * FROM pwa_apps;
|
||||
```
|
||||
|
||||
## 📝 Sample Apps to Try
|
||||
|
||||
### PWAs
|
||||
- **Twitter**: `https://mobile.twitter.com`
|
||||
- **Spotify**: `https://open.spotify.com`
|
||||
- **YouTube**: `https://m.youtube.com`
|
||||
- **Instagram**: `https://www.instagram.com`
|
||||
- **Notion**: `https://www.notion.so`
|
||||
|
||||
### WASM Demos
|
||||
- **WebAssembly.org Demo**: `https://webassembly.org/demo/`
|
||||
- **Figma**: `https://www.figma.com` (uses WASM)
|
||||
- **Google Earth**: `https://earth.google.com/web/`
|
||||
- **Photopea**: `https://www.photopea.com` (Photoshop in browser)
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### "Gradle Sync Failed"
|
||||
```bash
|
||||
# Clean and rebuild
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
### "Device Not Found"
|
||||
```bash
|
||||
# Check connected devices
|
||||
adb devices
|
||||
|
||||
# If empty, enable USB debugging on your Android device:
|
||||
# Settings → About Phone → Tap "Build Number" 7 times
|
||||
# Settings → Developer Options → Enable "USB Debugging"
|
||||
```
|
||||
|
||||
### "Build Failed"
|
||||
1. Check JDK version: `java -version` (must be 17+)
|
||||
2. Update Android Studio to latest
|
||||
3. Invalidate caches: File → Invalidate Caches / Restart
|
||||
|
||||
### WebView Not Loading
|
||||
- Check internet connection
|
||||
- Verify URL starts with `https://`
|
||||
- Try a different URL
|
||||
- Check device logs: `adb logcat | grep SilverDROID`
|
||||
|
||||
## 🎯 Project Structure (Quick Reference)
|
||||
|
||||
```
|
||||
SilverDROID/
|
||||
├── app/src/main/kotlin/uk/silverlabs/silverdroid/
|
||||
│ ├── MainActivity.kt # Entry point
|
||||
│ ├── ui/launcher/ # Main screen
|
||||
│ ├── ui/webview/ # PWA container
|
||||
│ ├── ui/components/ # Glass components
|
||||
│ ├── ui/theme/ # Theming
|
||||
│ └── data/ # Database
|
||||
├── build.gradle.kts # Build config
|
||||
└── README.md # Full docs
|
||||
```
|
||||
|
||||
## 📚 Next Steps
|
||||
|
||||
1. **Customize Colors**
|
||||
- Edit `ui/theme/Color.kt`
|
||||
- Change glass tint/opacity
|
||||
- Adjust Material Design colors
|
||||
|
||||
2. **Add Features**
|
||||
- Settings screen
|
||||
- Icon caching
|
||||
- Categories/tags
|
||||
- Search functionality
|
||||
|
||||
3. **Deploy**
|
||||
- Build release APK: `./gradlew assembleRelease`
|
||||
- Sign with your keystore
|
||||
- Distribute or publish
|
||||
|
||||
## 💡 Pro Tips
|
||||
|
||||
### Fast Iteration
|
||||
1. Keep Android Studio open
|
||||
2. Make changes in `.kt` files
|
||||
3. Use "Apply Changes" (⚡) instead of full rebuild
|
||||
4. Test on real device for better performance
|
||||
|
||||
### Glass Effects
|
||||
- Adjust blur radius in `GlassComponents.kt`
|
||||
- Modify alpha values for transparency
|
||||
- Experiment with gradient colors in `GlassBackground`
|
||||
|
||||
### Performance
|
||||
- Test on real devices (emulator is slower)
|
||||
- Profile with Android Profiler
|
||||
- Monitor WebView memory usage
|
||||
- Optimize large app lists (already using LazyGrid)
|
||||
|
||||
---
|
||||
|
||||
## 🎉 That's It!
|
||||
|
||||
You now have a working Android PWA/WASM launcher with glassmorphism UI!
|
||||
|
||||
**Questions?** Check the full README.md or PROJECT_SUMMARY.md
|
||||
|
||||
**Issues?** https://gitlab.silverlabs.uk/SilverLABS/silverdroid/issues
|
||||
|
||||
---
|
||||
|
||||
**Built with ❤️ by SilverLABS**
|
||||
Reference in New Issue
Block a user