jellytau/scripts/README.md

83 lines
1.8 KiB
Markdown

# Development Scripts
Collection of utility scripts for building, testing, and deploying JellyTau.
## Testing Scripts
### `test-all.sh`
Run all tests (frontend + Rust backend).
```bash
./scripts/test-all.sh
```
### `test-frontend.sh`
Run frontend tests only.
```bash
./scripts/test-frontend.sh # Run all tests
./scripts/test-frontend.sh --watch # Watch mode
./scripts/test-frontend.sh --ui # Open UI
```
### `test-rust.sh`
Run Rust tests only.
```bash
./scripts/test-rust.sh # Run all tests
./scripts/test-rust.sh -- --nocapture # Show println! output
```
## Android Scripts
### `build-android.sh`
Build the Android APK.
```bash
./scripts/build-android.sh # Debug build
./scripts/build-android.sh release # Release build
```
### `deploy-android.sh`
Install APK on connected Android device.
```bash
./scripts/deploy-android.sh # Deploy debug APK
./scripts/deploy-android.sh release # Deploy release APK
```
### `build-and-deploy.sh`
Build and deploy in one command.
```bash
./scripts/build-and-deploy.sh # Build + deploy debug
./scripts/build-and-deploy.sh release # Build + deploy release
```
### `check-android.sh`
Check Android development environment setup.
```bash
./scripts/check-android.sh
```
### `logcat.sh`
View Android logcat filtered for the app.
```bash
./scripts/logcat.sh
```
## Utility Scripts
### `clean.sh`
Clean all build artifacts.
```bash
./scripts/clean.sh
```
## NPM Script Aliases
You can also run these via npm/bun:
```bash
bun run test:all # All tests
bun run test:rust # Rust tests
bun run android:build # Build Android APK
bun run android:deploy # Deploy to device
bun run android:dev # Build + deploy debug
bun run android:check # Check environment
bun run clean # Clean artifacts
```