MentraOS-Cloud-Example-App

Install MentraOS on your phone

MentraOS install links: mentra.glass/install

(Easiest way to get started) Set up ngrok

• brew install ngrok

• Make an ngrok account

• Use ngrok to make a static address/URL

Register your App with MentraOS

• Navigate to console.mentra.glass

• Click "Sign In", and log in with the same account you're using for MentraOS

• Click "Create App"

• Set a unique package name like com.yourName.yourAppName

• For "Public URL", enter your Ngrok's static URL

• In the edit app screen, add the microphone permission

Get your App running!

• Install bun

• Create a new repo from this template using the Use this template dropdown in the upper right or the following command: gh repo create --template Mentra-Community/MentraOS-Cloud-Example-App

• Clone your new repo locally: git clone <your-repo-url>

• cd into your repo, then type bun install

• 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

• Run your app with bun run dev

• 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

Subscribing to events

You can listen for transcriptions, translations, and other events within the onSession function.