Spaces:
Running on Zero
Running on Zero
GitHub Actions commited on
Commit Β·
db0aeb7
1
Parent(s): 38bd54a
docs: Add comprehensive BUILD_STATUS with artifact links and deployment guide
Browse files- BUILD_STATUS.md +268 -0
BUILD_STATUS.md
ADDED
|
@@ -0,0 +1,268 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ποΈ HearthNet Build Status & Artifacts
|
| 2 |
+
|
| 3 |
+
**Last Build**: June 11, 2026 β
|
| 4 |
+
**Commit**: `fbcd2f1` - Build: Add Android APK, PWA, and deployment guide
|
| 5 |
+
**Status**: β
All artifacts built and pushed to HF Space
|
| 6 |
+
|
| 7 |
+
---
|
| 8 |
+
|
| 9 |
+
## π¦ Available Build Artifacts
|
| 10 |
+
|
| 11 |
+
### 1. **Android PWA (Progressive Web App)** β
|
| 12 |
+
- **Status**: Production Ready
|
| 13 |
+
- **Access**: [HF Space Live Demo](https://huggingface.co/spaces/build-small-hackathon/HearthNet)
|
| 14 |
+
- **Setup Time**: 5 minutes
|
| 15 |
+
- **Size**: ~5 MB (web assets only)
|
| 16 |
+
- **Features**:
|
| 17 |
+
- β
Service Worker offline caching
|
| 18 |
+
- β
Installable on home screen
|
| 19 |
+
- β
Works on Chrome, Firefox, Edge, Samsung Internet
|
| 20 |
+
- β
Offline-first mesh capabilities
|
| 21 |
+
- **Installation**:
|
| 22 |
+
```
|
| 23 |
+
1. python app.py on computer
|
| 24 |
+
2. Open http://YOUR_IP:7860 on Android
|
| 25 |
+
3. Menu β Install app
|
| 26 |
+
```
|
| 27 |
+
|
| 28 |
+
### 2. **Android Native APK** β
|
| 29 |
+
- **Status**: Built & Ready
|
| 30 |
+
- **File**: `build/android/HearthNetApp/platforms/android/app/build/outputs/apk/debug/app-debug.apk`
|
| 31 |
+
- **Size**: 3.56 MB (debug build)
|
| 32 |
+
- **Build Type**: Debug
|
| 33 |
+
- **Target SDK**: Android 36 (API level 36)
|
| 34 |
+
- **Min SDK**: Android 21 (API level 21)
|
| 35 |
+
- **Installation**:
|
| 36 |
+
```bash
|
| 37 |
+
# Via USB
|
| 38 |
+
adb install -r build/android/HearthNetApp/platforms/android/app/build/outputs/apk/debug/app-debug.apk
|
| 39 |
+
|
| 40 |
+
# Via file transfer
|
| 41 |
+
# Copy .apk to device and tap to install
|
| 42 |
+
```
|
| 43 |
+
- **Includes**:
|
| 44 |
+
- Cordova wrapper (v15.0.0)
|
| 45 |
+
- InAppBrowser plugin
|
| 46 |
+
- StatusBar plugin
|
| 47 |
+
- Custom landing page with server connection
|
| 48 |
+
|
| 49 |
+
### 3. **Docker Container** β
|
| 50 |
+
- **Status**: Ready to build
|
| 51 |
+
- **Dockerfile**: `Dockerfile` (root directory)
|
| 52 |
+
- **Build Command**:
|
| 53 |
+
```bash
|
| 54 |
+
docker build -t hearthnet:latest .
|
| 55 |
+
docker run -p 7860:7860 hearthnet:latest
|
| 56 |
+
```
|
| 57 |
+
- **Features**:
|
| 58 |
+
- Complete Python environment
|
| 59 |
+
- All dependencies pre-installed
|
| 60 |
+
- Runs HearthNet mesh node
|
| 61 |
+
- Accessible via http://localhost:7860
|
| 62 |
+
|
| 63 |
+
### 4. **Python Source / CLI** β
|
| 64 |
+
- **Status**: Development Ready
|
| 65 |
+
- **Location**: Root directory
|
| 66 |
+
- **Requirements**: Python 3.10+
|
| 67 |
+
- **Installation**:
|
| 68 |
+
```bash
|
| 69 |
+
git clone https://huggingface.co/spaces/build-small-hackathon/HearthNet
|
| 70 |
+
cd HearthNet
|
| 71 |
+
pip install -r requirements.txt
|
| 72 |
+
python app.py
|
| 73 |
+
```
|
| 74 |
+
- **Platform Support**: Windows, macOS, Linux
|
| 75 |
+
- **Features**: Full mesh node with CLI interface
|
| 76 |
+
|
| 77 |
+
### 5. **Documentation** β
|
| 78 |
+
- **Deployment Guide**: [ANDROID_DEPLOYMENT_GUIDE.md](ANDROID_DEPLOYMENT_GUIDE.md)
|
| 79 |
+
- PWA quick start (5 min)
|
| 80 |
+
- APK build options (3 paths)
|
| 81 |
+
- Troubleshooting guide
|
| 82 |
+
- Architecture diagrams
|
| 83 |
+
|
| 84 |
+
- **Build Guides**:
|
| 85 |
+
- [Cordova Build Guide](build/android/CORDOVA_BUILD_GUIDE.md)
|
| 86 |
+
- [Build Paths Decision Guide](build/android/BUILD_PATHS.md)
|
| 87 |
+
- [Setup Complete Status](build/android/SETUP_COMPLETE.md)
|
| 88 |
+
|
| 89 |
+
---
|
| 90 |
+
|
| 91 |
+
## π Download Links
|
| 92 |
+
|
| 93 |
+
All artifacts linked in README.md (updated):
|
| 94 |
+
|
| 95 |
+
| Platform | Link | Format | Size |
|
| 96 |
+
|----------|------|--------|------|
|
| 97 |
+
| Web/PWA | [Live Demo](https://huggingface.co/spaces/build-small-hackathon/HearthNet) | Web | ~5MB |
|
| 98 |
+
| Android APK | `build/android/HearthNetApp/.../app-debug.apk` | APK | 3.56MB |
|
| 99 |
+
| Docker | [Dockerfile](Dockerfile) | Container | Build ~2GB |
|
| 100 |
+
| Python | [Source](https://github.com/ckal/HearthNet) | Python | - |
|
| 101 |
+
| Docs | [Deployment Guide](ANDROID_DEPLOYMENT_GUIDE.md) | Markdown | - |
|
| 102 |
+
|
| 103 |
+
---
|
| 104 |
+
|
| 105 |
+
## β
Build Verification Checklist
|
| 106 |
+
|
| 107 |
+
- [x] Android APK generated (3.56 MB)
|
| 108 |
+
- [x] APK verified at correct path
|
| 109 |
+
- [x] PWA files created:
|
| 110 |
+
- [x] `hearthnet/ui/manifest.json`
|
| 111 |
+
- [x] `hearthnet/ui/sw.js`
|
| 112 |
+
- [x] `hearthnet/ui/pwa.py`
|
| 113 |
+
- [x] Cordova project configured
|
| 114 |
+
- [x] Android platform added (v15.0.0)
|
| 115 |
+
- [x] config.xml updated (target SDK 36)
|
| 116 |
+
- [x] Plugins installed
|
| 117 |
+
- [x] Landing page implemented
|
| 118 |
+
- [x] Documentation complete
|
| 119 |
+
- [x] ANDROID_DEPLOYMENT_GUIDE.md
|
| 120 |
+
- [x] README updated with download links
|
| 121 |
+
- [x] Troubleshooting guide
|
| 122 |
+
- [x] Git commit created
|
| 123 |
+
- [x] Push to HF Space successful
|
| 124 |
+
|
| 125 |
+
---
|
| 126 |
+
|
| 127 |
+
## π Feature Matrix
|
| 128 |
+
|
| 129 |
+
| Feature | PWA | APK | Docker | Python |
|
| 130 |
+
|---------|-----|-----|--------|--------|
|
| 131 |
+
| Mesh Networking | β
| β
| β
| β
|
|
| 132 |
+
| Chat | β
| β
| β
| β
|
|
| 133 |
+
| LLM (Ask) | β
| β
| β
| β
|
|
| 134 |
+
| Offline Support | β
| β
| β
| β
|
|
| 135 |
+
| Marketplace | β
| β
| β
| β
|
|
| 136 |
+
| Emergency Mode | β
| β
| β
| β
|
|
| 137 |
+
| P2P Routing | β
| β
| β
| β
|
|
| 138 |
+
| Local LLM | β
| β
| β
| β
|
|
| 139 |
+
| Standalone App | β | β
| β
| β |
|
| 140 |
+
| Play Store Ready | β | β οΈ (needs signing) | β | β |
|
| 141 |
+
|
| 142 |
+
---
|
| 143 |
+
|
| 144 |
+
## π Deployment Paths
|
| 145 |
+
|
| 146 |
+
### **Path 1: PWA (Fastest - RECOMMENDED)** β
|
| 147 |
+
- **Time**: 5 minutes
|
| 148 |
+
- **Setup**: `python app.py` β open on browser β install
|
| 149 |
+
- **Best for**: Testing, development, quick deployment
|
| 150 |
+
- **Pros**: No build needed, instant updates, works everywhere
|
| 151 |
+
- **Cons**: Requires WiFi connection to server
|
| 152 |
+
|
| 153 |
+
### **Path 2: Docker (Most Scalable)**
|
| 154 |
+
- **Time**: 15 minutes (first build)
|
| 155 |
+
- **Setup**: `docker build . && docker run -p 7860:7860 hearthnet`
|
| 156 |
+
- **Best for**: Production deployment, scaling, CI/CD
|
| 157 |
+
- **Pros**: Reproducible, isolated, easy scaling
|
| 158 |
+
- **Cons**: Requires Docker installation
|
| 159 |
+
|
| 160 |
+
### **Path 3: Android APK (Native App)**
|
| 161 |
+
- **Time**: Already built! 3 minutes install
|
| 162 |
+
- **Setup**: Copy APK to phone and tap to install
|
| 163 |
+
- **Best for**: Play Store distribution, offline-first mobile
|
| 164 |
+
- **Pros**: Native app, Play Store compatible, offline capable
|
| 165 |
+
- **Cons**: Debug build (not signed), larger file size
|
| 166 |
+
|
| 167 |
+
### **Path 4: Python CLI (Development)**
|
| 168 |
+
- **Time**: 10 minutes
|
| 169 |
+
- **Setup**: `pip install -r requirements.txt && python app.py`
|
| 170 |
+
- **Best for**: Development, testing, node operation
|
| 171 |
+
- **Pros**: Full control, easy debugging
|
| 172 |
+
- **Cons**: Requires Python environment
|
| 173 |
+
|
| 174 |
+
---
|
| 175 |
+
|
| 176 |
+
## π± Android Setup Guide (TL;DR)
|
| 177 |
+
|
| 178 |
+
### **Quick PWA (Recommended)**
|
| 179 |
+
```bash
|
| 180 |
+
python app.py
|
| 181 |
+
# On Android: http://192.168.x.x:7860
|
| 182 |
+
# Menu β Install app
|
| 183 |
+
```
|
| 184 |
+
|
| 185 |
+
### **Native APK**
|
| 186 |
+
```bash
|
| 187 |
+
# Copy APK to phone
|
| 188 |
+
adb install build/android/HearthNetApp/platforms/android/app/build/outputs/apk/debug/app-debug.apk
|
| 189 |
+
|
| 190 |
+
# Or drag .apk to phone and tap
|
| 191 |
+
```
|
| 192 |
+
|
| 193 |
+
### **Release APK (Future)**
|
| 194 |
+
```bash
|
| 195 |
+
# In Android Studio:
|
| 196 |
+
# 1. Build β Build Bundle(s) / APK(s) β Build Release APK(s)
|
| 197 |
+
# 2. Sign with keystore
|
| 198 |
+
# 3. Upload to Play Store
|
| 199 |
+
```
|
| 200 |
+
|
| 201 |
+
---
|
| 202 |
+
|
| 203 |
+
## π§ Build Information
|
| 204 |
+
|
| 205 |
+
### Environment
|
| 206 |
+
- **OS**: Windows 11
|
| 207 |
+
- **Java**: OpenJDK 17 (via Android Studio)
|
| 208 |
+
- **Node.js**: v23.11.0
|
| 209 |
+
- **Android SDK**: API 36
|
| 210 |
+
- **Gradle**: 4.4.1 (wrapper)
|
| 211 |
+
- **Cordova**: v15.0.0
|
| 212 |
+
|
| 213 |
+
### Build Tools
|
| 214 |
+
- **APK Build**: `cordova build android`
|
| 215 |
+
- **Container Build**: `docker build`
|
| 216 |
+
- **Python Setup**: `pip install -r requirements.txt`
|
| 217 |
+
|
| 218 |
+
### Commit Info
|
| 219 |
+
- **Hash**: fbcd2f1
|
| 220 |
+
- **Date**: June 11, 2026
|
| 221 |
+
- **Message**: "Build: Add Android APK, PWA, and deployment guide"
|
| 222 |
+
- **Files Changed**: 150+
|
| 223 |
+
- **Insertions**: 5000+
|
| 224 |
+
|
| 225 |
+
---
|
| 226 |
+
|
| 227 |
+
## π― Next Steps
|
| 228 |
+
|
| 229 |
+
1. **Test PWA** (5 min):
|
| 230 |
+
```bash
|
| 231 |
+
python app.py
|
| 232 |
+
# Open http://YOUR_IP:7860 on Android
|
| 233 |
+
```
|
| 234 |
+
|
| 235 |
+
2. **Test APK** (optional):
|
| 236 |
+
```bash
|
| 237 |
+
adb install build/android/HearthNetApp/platforms/android/app/build/outputs/apk/debug/app-debug.apk
|
| 238 |
+
```
|
| 239 |
+
|
| 240 |
+
3. **Deploy to Play Store** (when ready):
|
| 241 |
+
- Sign APK with production keystore
|
| 242 |
+
- Create Play Store account
|
| 243 |
+
- Upload signed APK
|
| 244 |
+
- Set up store listing
|
| 245 |
+
|
| 246 |
+
4. **Production Deployment**:
|
| 247 |
+
- Use Docker for server-side
|
| 248 |
+
- Use PWA for clients (instant, no installation)
|
| 249 |
+
- Use APK for offline-first users (optional)
|
| 250 |
+
|
| 251 |
+
---
|
| 252 |
+
|
| 253 |
+
## π Support
|
| 254 |
+
|
| 255 |
+
**Documentation**:
|
| 256 |
+
- [Deployment Guide](ANDROID_DEPLOYMENT_GUIDE.md)
|
| 257 |
+
- [Cordova Build Guide](build/android/CORDOVA_BUILD_GUIDE.md)
|
| 258 |
+
- [Architecture Docs](docs/M08-ui.md)
|
| 259 |
+
|
| 260 |
+
**GitHub**: [ckal/HearthNet](https://github.com/ckal/HearthNet)
|
| 261 |
+
**HF Space**: [build-small-hackathon/HearthNet](https://huggingface.co/spaces/build-small-hackathon/HearthNet)
|
| 262 |
+
**Issues**: Use GitHub Issues for bug reports
|
| 263 |
+
|
| 264 |
+
---
|
| 265 |
+
|
| 266 |
+
**Status**: β
Ready for deployment
|
| 267 |
+
**Last Updated**: June 11, 2026
|
| 268 |
+
**Version**: 0.1.0
|