add contact name spport and upadtes to webui
This commit is contained in:
35
README.md
35
README.md
@@ -10,7 +10,7 @@ An Android app that turns your phone into an SMS API gateway with a web interfac
|
||||
- **Local Database** - All messages stored locally with delivery tracking
|
||||
- **Background Service** - Runs as a foreground service with persistent notification
|
||||
- **Auto-start** - Optionally start on device boot
|
||||
- **Root Port Redirect** - Use ports 80/443 with root access via iptables
|
||||
- **Root Support** - Bind directly to ports 80/443 with root access
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -25,32 +25,22 @@ An Android app that turns your phone into an SMS API gateway with a web interfac
|
||||
|
||||
- Android Studio or command line with Android SDK
|
||||
- JDK 11+
|
||||
- Node.js 18+ (for web UI)
|
||||
|
||||
### Build Steps
|
||||
|
||||
1. **Clone the repository**
|
||||
```bash
|
||||
git clone <repo-url>
|
||||
git clone https://git.shihaam.dev/shihaam/textpipe
|
||||
cd textpipe
|
||||
```
|
||||
|
||||
2. **Build the Web UI**
|
||||
```bash
|
||||
cd webui
|
||||
npm install
|
||||
npm run build
|
||||
cd ..
|
||||
```
|
||||
This builds the Vue frontend to `app/src/main/assets/webui/`
|
||||
|
||||
3. **Build the Android App**
|
||||
2. **Build the Android App**
|
||||
```bash
|
||||
./gradlew assembleDebug
|
||||
```
|
||||
The APK will be at `app/build/outputs/apk/debug/app-debug.apk`
|
||||
|
||||
4. **Install on device**
|
||||
3. **Install on device**
|
||||
```bash
|
||||
adb install app/build/outputs/apk/debug/app-debug.apk
|
||||
```
|
||||
@@ -190,7 +180,7 @@ curl -H "X-API-Key: your-api-key-here" \
|
||||
- Default port: 8080
|
||||
- Can be changed in the app UI
|
||||
- For ports below 1024 (like 80 or 443), root access is required
|
||||
- With root, the app uses iptables to redirect traffic from the privileged port to the actual server port
|
||||
- With root, the app uses sysctl to allow binding to privileged ports directly
|
||||
|
||||
### Auto-start
|
||||
|
||||
@@ -228,16 +218,9 @@ textpipe/
|
||||
│ │ ├── sim/ # SIM management
|
||||
│ │ ├── root/ # Root utilities
|
||||
│ │ └── ui/ # Compose UI
|
||||
│ ├── assets/webui/ # Built web UI
|
||||
│ ├── assets/webui/ # Web UI (vanilla HTML/CSS/JS)
|
||||
│ │ └── index.html
|
||||
│ └── AndroidManifest.xml
|
||||
├── webui/ # Vue.js web interface
|
||||
│ ├── src/
|
||||
│ │ ├── App.vue
|
||||
│ │ ├── api.js
|
||||
│ │ ├── style.css
|
||||
│ │ └── components/
|
||||
│ ├── package.json
|
||||
│ └── vite.config.js
|
||||
├── gradle/
|
||||
│ └── libs.versions.toml # Dependency versions
|
||||
└── build.gradle.kts
|
||||
@@ -254,9 +237,7 @@ textpipe/
|
||||
- kotlinx.serialization (JSON)
|
||||
|
||||
### Web UI
|
||||
- Vue 3
|
||||
- Vite
|
||||
- Vanilla CSS
|
||||
- Vanilla HTML/CSS/JS (no build step required)
|
||||
|
||||
## Message Status Flow
|
||||
|
||||
|
||||
Reference in New Issue
Block a user