Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Unverified Commit ec46a173 authored by Simon Chan's avatar Simon Chan
Browse files

chore: remove deprecated packages

parent 3a14c162
Loading
Loading
Loading
Loading

.github/workflows/deploy.yml

deleted100644 → 0
+0 −40
Original line number Diff line number Diff line
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

name: Deploy

on:
  push:
    branches: [main]

env:
  BASE_PATH: /ya-webadb

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Use Node.js 18.x
        uses: actions/setup-node@v3
        with:
          node-version: 18.x

      - run: node common/scripts/install-run-rush.js install
      - run: node common/scripts/install-run-rush.js build --verbose

      - run: npx next export
        working-directory: ./apps/demo

      - run: touch apps/demo/out/.nojekyll

      - name: Deploy
        uses: s0/git-publish-subdir-action@develop
        env:
          REPO: self
          BRANCH: gh-pages
          FOLDER: apps/demo/out
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+0 −24
Original line number Diff line number Diff line
@@ -37,30 +37,6 @@ $ rush install
    $ rush build:watch
    ```

-   Start demo's dev-server:

    ```sh
    $ cd apps/demo
    $ npm run dev
    ```

Usually you need two terminals to run both 2 and 3 to test your changes.

## Deploy Demo

The demo is built with [Next.js](https://nextjs.org/), a full-stack React framework, which usually requires a Node.js environment to run.

However, since the demo doesn't have any server-side code, the most simple deployment method is to use the [Static HTML Export](https://nextjs.org/docs/advanced-features/static-html-export) feature of Next.js. It generates pre-rendered, fully static HTML files, that can be deployed to any static website hosting services (e.g. GitHub Pages).

To export static deployable HTML files, after running `rush build` command, run:

```sh
cd apps/demo
npx next export
```

This will create an `out` folder containing exported HTML files and all required resource files.

## Release new versions

```sh
+16 −39
Original line number Diff line number Diff line
@@ -4,11 +4,9 @@

A library and a Web app that allow browsers to interact with Android devices via ADB (Android Debugging Protocol).

All features work on Chrome for Android, use a C-to-C (or OTG) cable or via WebSockify running in Termux (see [compatibility table](#compatibility) below).
All features work on Chrome for Android, use a C-to-C (or OTG) cable.

[🚀 Web App](https://tango-web-mu.vercel.app/) | [Old demo](https://yume-chan.github.io/ya-webadb)

For USB connection, close Google ADB (Run `adb kill-server` in a terminal or close `adb.exe` from Task Manager) and all programs that may use ADB (e.g. Android Studio, Visual Studio, Godot Editor, etc.) before connecting.
[🚀 Web App](https://tango-web-mu.vercel.app/) | [Old Demo](https://tango-adb.github.io/old-demo/)

## Working Modes

@@ -18,49 +16,30 @@ In this mode, Google ADB is not required for this library to communicate with An

This mode is suitable for running on end-users' devices where Google ADB is not installed, or on mobile devices where Google ADB is not available.

Before connecting, make sure to close Google ADB (Run `adb kill-server` in a terminal or close `adb.exe` from Task Manager) and all programs that may use ADB (e.g. Android Studio, Visual Studio, Godot Editor, etc.).

### Google ADB Client Mode

In this mode, this library talks to a Google ADB server, which is either running on the same machine or on a remote machine. This allows other ADB-based tools to work alongside this library.

## Compatibility

| Connection                                | Chromium-based Browsers          | Firefox   | Node.js                       |
| ----------------------------------------- | -------------------------------- | --------- | ----------------------------- |
| USB cable                                 | Supported using [WebUSB] API     | No        | Supported using `usb` package |
| Wireless through [WebSocket] <sup>1</sup> | Supported                        | Supported | Possible using `ws` package   |
| Wireless through TCP                      | Waiting for [Direct Sockets] API | No        | Possible using `net` module   |
| Connection                       | Chromium-based Browsers          | Node.js                       |
| -------------------------------- | -------------------------------- | ----------------------------- |
| Direct Connection over USB cable | Supported using [WebUSB] API     | Supported using `usb` package |
| Direct Connection over TCP       | Waiting for [Direct Sockets] API | Possible using `net` module   |
| Google ADB client over TCP       | Waiting for [Direct Sockets] API | Supported using `net` module  |

[webusb]: https://wicg.github.io/webusb/
[websocket]: https://websockets.spec.whatwg.org/
[direct sockets]: https://wicg.github.io/direct-sockets/

<sup>1</sup> Requires WebSockify softwares, see [instruction](https://github.com/yume-chan/ya-webadb/discussions/245#discussioncomment-384030) for detail.

## Features

-   📁 File Management
    -   📋 List
    -   ⬆ Upload
    -   ⬇ Download
    -   🗑 Delete
-   📷 Screen Capture
-   📜 Terminal Emulator powered by [Tabby](https://github.com/Eugeny/tabby)
    -   Tabs and split panes
    -   Color themes
    -   Rich configuration
-   ⚙ Enable ADB over WiFi
-   📦 Install APK
-   🎥 [Scrcpy](https://github.com/Genymobile/scrcpy) compatible client
    -   Screen mirroring
    -   Audio forwarding (Android >= 11)
    -   Recording
    -   Control device with mouse, touch and keyboard
-   🐛 Chrome Remote Debugging that supporting
    -   Google Chrome (stable, beta, dev, canary)
    -   Microsoft Edge (stable, beta, dev, canary)
    -   Opera (stable, beta)
    -   Vivaldi
-   🔌 Power and reboot to different modes
## API documentation

Currently the API is unstable and the documentation is lacking, but there are three sources you can refer to:

-   Each package's `README.md` file
-   The source code of old demo at https://github.com/tango-adb/old-demo (it's a React app)
-   The work-in-progress documentation site at https://yume-chan.github.io/unofficial-adb-book/adb/installation

## Contribute

@@ -86,6 +65,4 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)

-   [ADB](https://android.googlesource.com/platform/packages/modules/adb) from Google ([Apache License 2.0](./adb.NOTICE))
-   [Scrcpy](https://github.com/Genymobile/scrcpy) from Romain Vimont ([Apache License 2.0](https://github.com/Genymobile/scrcpy/blob/master/LICENSE))
-   [Tabby](https://github.com/Eugeny/tabby) from Eugeny ([MIT License](https://github.com/Eugeny/tabby/blob/master/LICENSE))
-   [webm-muxer](https://github.com/Vanilagy/webm-muxer) from Vanilagy ([MIT License](https://github.com/Vanilagy/webm-muxer/blob/main/LICENSE))
-   [web-streams-polyfill](https://github.com/MattiasBuelens/web-streams-polyfill) from Mattias Buelens ([MIT License](https://github.com/MattiasBuelens/web-streams-polyfill/blob/master/LICENSE))

apps/demo/.eslintrc.json

deleted100644 → 0
+0 −3
Original line number Diff line number Diff line
{
  "extends": "next/core-web-vitals"
}

apps/demo/.gitignore

deleted100644 → 0
+0 −41
Original line number Diff line number Diff line
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env.local
.env.development.local
.env.test.local
.env.production.local

# vercel
.vercel

public/manifest.json
public/fallback-*.js
public/sw.js
public/sw.js.map
public/workbox-*.js
public/workbox-*.js.map
Loading