Initial commit

Author: Ryan-Rong-24

.env.example

@@ -0,0 +1,8 @@
+# Server port - The port on which the application will run (default: 3000)
+PORT=3000
+
+# App package name - Your application's unique identifier.  Make sure it exactly matches the package name in the MentraOS Developer Console
+PACKAGE_NAME=org.yourname.appname
+
+# API key - Your MentraOS developer API key from the MentraOS Developer Console (never commit the key to source control)
+MENTRAOS_API_KEY=your_api_key_here

.github/workflows/porter_app_camera-photo-example_4689.yml

@@ -0,0 +1,29 @@
+"on":
+    push:
+        branches:
+            - main
+name: Deploy to camera-photo-example
+jobs:
+    porter-deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+            - name: Set Github tag
+              id: vars
+              run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+            - name: Setup porter
+              uses: porter-dev/setup-porter@v0.1.0
+            - name: Deploy stack
+              timeout-minutes: 30
+              run: exec porter apply -f ./porter.yaml
+              env:
+                PORTER_APP_NAME: camera-photo-example
+                PORTER_CLUSTER: "4689"
+                PORTER_DEPLOYMENT_TARGET_ID: 4a24a192-04c8-421f-8fc2-22db1714fdc0
+                PORTER_HOST: https://dashboard.porter.run
+                PORTER_PR_NUMBER: ${{ github.event.number }}
+                PORTER_PROJECT: "15081"
+                PORTER_REPO_NAME: ${{ github.event.repository.name }}
+                PORTER_TAG: ${{ steps.vars.outputs.sha_short }}
+                PORTER_TOKEN: ${{ secrets.PORTER_APP_15081_4689 }}

.gitignore

@@ -0,0 +1,13 @@
+.env
+node_modules/
+bun.lock
+.DS_Store
+*.log
+# VSCode
+.vscode/
+# Mac system files
+.DS_Store
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log* 

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mentra Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,60 @@
+# MentraOS-Camera-Example-App
+
+This is a simple example app which demonstrates how to use the MentraOS Camera API to take photos and display them in a webview.
+
+You could also send the photo to an AI api, store it in a database or cloud storage, send it to Roboflow, or do other processing.
+
+### Install MentraOS on your phone
+
+MentraOS install links: [mentra.glass/install](https://mentra.glass/install)
+
+### (Easiest way to get started) Set up ngrok
+
+1. `brew install ngrok`
+
+2. Make an ngrok account
+
+3. [Use ngrok to make a static address/URL](https://dashboard.ngrok.com/)
+
+### Register your App with MentraOS
+
+1. Navigate to [console.mentra.glass](https://console.mentra.glass/)
+
+2. Click "Sign In", and log in with the same account you're using for MentraOS
+
+3. Click "Create App"
+
+4. Set a unique package name like `com.yourName.yourAppName`
+
+5. For "Public URL", enter your Ngrok's static URL
+
+6. In the edit app screen, add the microphone permission
+
+### Get your App running!
+
+1. [Install bun](https://bun.sh/docs/installation)
+
+2. Clone this repo locally: `git clone https://github.com/Mentra-Community/MentraOS-Camera-Example-App`
+
+3. cd into your repo, then type `bun install`
+
+5. Set up your environment variables:
+   * Create a `.env` file in the root directory by copying the example: `cp .env.example .env`
+   * Edit the `.env` file with your app details:
+     ```
+     PORT=3000
+     PACKAGE_NAME=com.yourName.yourAppName
+     MENTRAOS_API_KEY=your_api_key_from_console
+     ```
+   * Make sure the `PACKAGE_NAME` matches what you registered in the MentraOS Console
+   * Get your `API_KEY` from the MentraOS Developer Console
+
+6. Run your app with `bun run dev`
+
+7. To expose your app to the internet (and thus MentraOS) with ngrok, run: `ngrok http --url=<YOUR_NGROK_URL_HERE> 3000`
+    * `3000` is the port. It must match what is in the app config. For example, if you entered `port: 8080`, use `8080` for ngrok instead.
+
+
+### Next Steps
+
+Check out the full documentation at [docs.mentra.glass](https://docs.mentra.glass/camera)