Create displayer application

sirknightj · May 2, 2024 · 3b5f306 · 3b5f306
1 parent e9ca6bd
commit 3b5f306
Show file tree

Hide file tree

Showing 28 changed files with 20,853 additions and 0 deletions.
diff --git a/.github/workflows/deploy-to-gh-pages.yml b/.github/workflows/deploy-to-gh-pages.yml
@@ -0,0 +1,15 @@
+name: Build and Deploy
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build and Deploy React app to GitHub Pages
+        uses: omkartapale/react-deployment-gh-pages@v1.0.0
diff --git a/.gitignore b/.gitignore
@@ -128,3 +128,14 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+/node_modules
+/.pnp
+.pnp.js
+
+.idea/
+*.iml
+
+.DS_Store
+
+build/
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# KVS TURN Server Displayer
+
+This browser application generates a temporary KVS WebRTC TURN session and displays the details necessary to use it. 
+
+## Getting started
+
+1. On the login screen, provide AWS Credentials.
+
+![Login Screen](./images/login-screen.png "Empty login screen")
+
+2. Next, specify a region and your Signaling Channel.
+
+![Fetcher Screen](./images/fetcher-screen.png "Signaling Channel Input")
+
+3. Choose Master or Viewer.
+
+4. Your TURN server session will be created and displayed on-screen. Choose the "Copy" buttons to copy the corresponding fields to your clipboard.
+
+![TURN Server Display Screen](./images/turn-server-display.png "TURN server display")
+
+## License
+
+This project is licensed under the Apache-2.0 License.
diff --git a/images/fetcher-screen.png b/images/fetcher-screen.png
diff --git a/images/login-screen.png b/images/login-screen.png
diff --git a/images/turn-server-display.png b/images/turn-server-display.png