2
2
sidebar_position : 3
3
3
---
4
4
5
- # Getting Started ( From Scratch)
5
+ # 🚧 Build From Scratch
6
6
7
7
* Last updated: March 31, 2025*
8
8
@@ -179,6 +179,13 @@ To make your locally running app accessible from the internet:
179
179
2 . Create an ngrok account
180
180
3 . [ Set up a static address/URL in the ngrok dashboard] ( https://dashboard.ngrok.com/ )
181
181
182
+ * Make sure you run the ` ngrok config add-authtoken <your_authtoken> ` line.
183
+ * Make sure you select ` Static Domain ` , then generate a static domain.
184
+
185
+ <center >
186
+ <img width =" 75% " src =" /img/ngrok_guide_1.png " ></img >
187
+ </center >
188
+
182
189
### 10. Register Your App
183
190
184
191
![ AugmentOS Console] ( https://github.com/user-attachments/assets/36192c2b-e1ba-423b-90de-47ff8cd91318 )
@@ -195,11 +202,9 @@ Edit your `index.ts` to match the app you registered:
195
202
196
203
``` typescript
197
204
const server = new MyAugmentOSApp ({
198
- packageName: " com.example.myfirstapp" , // Must match what you registered
205
+ packageName: " com.example.myfirstapp" , // Must match your packageName in console.AugmentOS.org
199
206
apiKey: ' your_api_key' , // Get this from console.AugmentOS.org
200
207
port: 3000 , // The port your server runs on
201
- augmentOSWebsocketUrl: ` ws://cloud.augmentos.org/tpa-ws ` , // Connects to AugmentOS Cloud
202
- webhookPath: ' /webhook' , // The path your server will listen on
203
208
});
204
209
```
205
210
@@ -222,7 +227,7 @@ ngrok http --url=<YOUR_NGROK_URL_HERE> 3000
222
227
Congratulations! You've built your first AugmentOS app. To continue your journey:
223
228
224
229
### Learn More
225
- - Explore [ Core Concepts] ( core-concepts ) to understand sessions, events, and the app lifecycle
230
+ - Explore [ 🚧 Core Concepts] ( core-concepts ) to understand sessions, events, and the app lifecycle
226
231
- Dive into [ Events] ( events ) to handle user interactions and sensor data
227
232
- Master [ Layouts] ( layouts ) to create rich visual experiences on smart glasses
228
233
0 commit comments