Merge pull request #3 from HRA42/main

add docker file, automatic builds via GitHub Actions and a short readme for manual use

.github/workflows/docker_build.yml

@@ -0,0 +1,71 @@
+name: Container Build + Publish
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Install the cosign tool except on PR
+      # https://github.com/sigstore/cosign-installer
+      - name: Install cosign
+        if: github.event_name != 'pull_request'
+        uses: sigstore/cosign-installer@main
+        with:
+          cosign-release: 'v1.11.0'
+
+
+      # Workaround: https://github.com/docker/build-push-action/issues/461
+      - name: Setup Docker buildx
+        uses: docker/setup-buildx-action@v3
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/[email protected]
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          platforms: linux/amd64,linux/arm64
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          tags: |
+            ghcr.io/${{ github.repository }}:latest

Dockerfile

@@ -0,0 +1,17 @@
+# Use the official Node.js image from the Docker Hub
+FROM node:18
+
+# Create and set the working directory inside the container
+WORKDIR /usr/src/app
+
+# Copy package.json and package-lock.json to the working directory
+COPY package*.json ./
+
+# Install the Node.js dependencies
+RUN npm install
+
+# Copy the rest of the application code to the working directory
+COPY . .
+
+# Define the command to run the application
+CMD ["npm", "run", "start"]

README.md

@@ -0,0 +1,28 @@
+# pieces-voice-chat
+
+A simply cli that allows you to have conversations with Pieces OS using just your voice.
+
+## Installation
+
+1. Clone the repository and switch to the project directory
+```bash
+git clone https://github.com/mason-at-pieces/pieces-voice-chat.git
+cd pieces-voice-chat
+```
+
+2. Install the dependencies
+```bash
+npm install
+```
+
+3. Run the application
+```bash
+npm run start
+```
+
+or you can use the prebuild docker image (currently only on Linux, for MacOS and Windows you need a way to passthrough a microphone to the container)
+
+```bash
+# make sure your microphone is connected to the host machine and can be accessed by the operating system
+docker run -it --device /dev/snd:/dev/snd ghcr.io/mason-at-pieces/pieces-voice-chat:latest
+```