Kindle Killer

Download AugmentOS on your phone

Download links

You probably want staging, unless you want raw audio bytes. If you want raw audio bytes, you want dev.

Set up ngrok

1. brew install ngrok

2. Make an ngrok account

3. Use ngrok to make a static address/URL

Register your APP with AugmentOS

1. Navigate to AugmentOS.dev

2. Click "Sign In", and log in with the same Google account you're using for AugmentOS

3. Click "Create App"

4. Set a UNIQUE package name like org.yourlastname.yoursocialsecuritynumber

5. For webhook url, enter your ngrok's static url, appended by webhook

   • EX:
     • If you Ngrok URL is: https://my-static-url.ngrok-free.app
     • Then you enter https://my-static-url.ngrok-free.app/webhook

Get your APP running!

1. Install bun

2. Clone this repo: git clone git@github.com:AugmentOS-Community/AugmentOS-Cloud-Example-App.git

3. cd into your repo, then type bun install

4. Edit your index.ts to match the app you registered at AugmentOS.dev

const app = new ExampleAugmentOSApp({
  packageName: 'org.yourlastname.yoursocialsecuritynumber', // make sure this matches your app in dev console
  apiKey: 'your_api_key', // Not used right now, can be anything
  port: 3000, // The port you're hosting the server on
  augmentOSWebsocketUrl: 'wss://dev.augmentos.org/tpa-ws' //AugmentOS url
});

7. Run your app with bun run index.ts

8. To expose your app to the internet (and thus AugmentOS) with ngrok, run: ngrok http --url=civil-frankly-javelin.ngrok-free.app 3000

   • 3000 is the port. It must match what is in the app config. If you entered port: 8080, use 8080 for ngrok instead.