1
1
# AugmentOS-Cloud-Example-App
2
2
3
+ ### Install AugmentOS on your phone
3
4
4
- ![ header ] ( https://github.com/user-attachments/assets/f69defec-7011-45f2-b258-94e6c712a758 )
5
+ AugmentOS install links: [ AugmentOS.org/install ] ( https://AugmentOS.org/install )
5
6
6
- ### Download AugmentOS on your phone
7
-
8
- [ Download links] ( https://drive.google.com/drive/folders/1l99ffBiWHnAe06HSJcgjIG-SnMuio70_?usp=sharing )
9
-
10
- Use the APK that is pointing to the * staging* env, as currently our dev / prod environments do not have the appstore
11
-
12
-
13
- ### Set up ngrok
7
+ ### (Easiest way to get started) Set up ngrok
14
8
15
9
1 . ` brew install ngrok `
16
10
@@ -22,20 +16,15 @@ Use the APK that is pointing to the *staging* env, as currently our dev / prod e
22
16
23
17
<img width =" 181 " alt =" image " src =" https://github.com/user-attachments/assets/36192c2b-e1ba-423b-90de-47ff8cd91318 " />
24
18
25
- 1 . Navigate to [ AugmentOS.dev ] ( https://augmentos.dev / )
19
+ 1 . Navigate to [ console. AugmentOS.org ] ( https://console.AugmentOS.org / )
26
20
27
- 2 . Click "Sign In", and log in with the same Google account you're using for AugmentOS
21
+ 2 . Click "Sign In", and log in with the same account you're using for AugmentOS
28
22
29
23
3 . Click "Create App"
30
24
31
- 4 . Set a UNIQUE package name like ` org.yourlastname.yoursocialsecuritynumber `
32
-
33
- 5 . For webhook url, enter your ngrok's static url, appended by ` webhook `
34
- * EX:
35
- * If you Ngrok URL is: ` https://my-static-url.ngrok-free.app `
36
- * Then you enter ` https://my-static-url.ngrok-free.app/webhook `
25
+ 4 . Set a unique package name like ` com.yourName.yourAppName `
37
26
38
- ![ guide ] ( https://github.com/user-attachments/assets/681df211-ea1a-4fd9-9563-f1f7c81e9565 )
27
+ 5 . For "Public URL", enter your Ngrok's static URL
39
28
40
29
### Get your APP running!
41
30
@@ -45,14 +34,13 @@ Use the APK that is pointing to the *staging* env, as currently our dev / prod e
45
34
46
35
3 . cd into your repo, then type ` bun install `
47
36
48
- 4 . Edit your ` index.ts ` to match the app you registered at [ AugmentOS.dev ] ( https://augmentos.dev / )
37
+ 4 . Edit your ` index.ts ` to match the app you registered at [ console. AugmentOS.org ] ( https://console.AugmentOS.org / )
49
38
50
39
``` typescript
51
40
const app = new ExampleAugmentOSApp ({
52
- packageName: ' org.yourlastname.yoursocialsecuritynumber' , // make sure this matches your app in dev console
53
- apiKey: ' your_api_key' , // Not used right now, can be anything
54
- port: 3000 , // The port you're hosting the server on
55
- augmentOSWebsocketUrl: ' wss://staging.augmentos.org/tpa-ws' // IMPORTANT: USE STAGING
41
+ packageName: ' com.yourName.yourAppName' , // The packageName you specified on console.AugmentOS.org
42
+ apiKey: ' your_api_key' , // Get this from console.AugmentOS.org
43
+ port: 3000 // The port you're hosting the server on
56
44
});
57
45
```
58
46
0 commit comments