|
1 | 1 | # Example Apps |
2 | 2 |
|
3 | 3 | This directory contains example applications demonstrating different levels of |
4 | | -usage of the |
5 | | -[react-native-background-geolocation](https://github.com/transistorsoft/react-native-background-geolocation) |
6 | | -SDK. |
7 | | - |
8 | | -Each app is intended to showcase a specific learning path, from minimal |
9 | | -integration to advanced, feature-rich usage. |
| 4 | +usage of the [react-native-background-geolocation](https://github.com/transistorsoft/react-native-background-geolocation) SDK. |
10 | 5 |
|
11 | 6 | --- |
12 | 7 |
|
13 | | -## Available Examples |
| 8 | +## Examples |
14 | 9 |
|
15 | | -### Advanced Demo App |
| 10 | +### Advanced Demo |
16 | 11 |
|
17 | 12 | **Path:** `./Advanced` |
18 | 13 |
|
19 | | -A full-featured demonstration app showcasing advanced capabilities of the SDK, |
20 | | -including: |
| 14 | +A full-featured demonstration app showcasing advanced capabilities of the SDK, including: |
21 | 15 |
|
22 | 16 | - Live map visualization |
23 | 17 | - Real-time configuration editing |
24 | 18 | - Circular and polygon geofences |
25 | 19 | - Motion state management |
26 | 20 | - Demo server registration and tracking |
27 | 21 |
|
28 | | -👉 See: [Advanced Demo App](./Advanced) |
29 | | - |
30 | | ---- |
31 | | - |
32 | | -### HelloWorld Demo App |
| 22 | +### HelloWorld Demo |
33 | 23 |
|
34 | 24 | **Path:** `./HelloWorld` |
35 | 25 |
|
36 | | -A minimal, stripped-down demo app focused on core SDK concepts, including: |
| 26 | +A minimal, stripped-down demo focused on core SDK concepts, including: |
37 | 27 |
|
38 | 28 | - Starting and stopping tracking |
39 | 29 | - Manually controlling motion state |
40 | 30 | - Requesting the current location |
41 | 31 | - Displaying basic tracking and event state |
42 | 32 |
|
43 | | -This app contains **no map view** and **no configuration UI**, making it ideal for |
44 | | -first-time users. |
| 33 | +No map view, no configuration UI — ideal for first-time users. |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +## Which Should I Use? |
| 38 | + |
| 39 | +- Start with **HelloWorld** if you want to understand the basics quickly. |
| 40 | +- Use **Advanced** if you want to explore the SDK's full capabilities and UI patterns. |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +## Demo Server |
| 45 | + |
| 46 | +When the app launches it will ask you to register an **organization** and **username**. The example app posts your tracking data to Transistor Software's demo server at: |
| 47 | + |
| 48 | +**[https://tracker.transistorsoft.com](https://tracker.transistorsoft.com)** |
45 | 49 |
|
46 | | -👉 See: [HelloWorld Demo App](./HelloWorld) |
| 50 | +View your results live on a map by navigating to: |
| 51 | + |
| 52 | +``` |
| 53 | +https://tracker.transistorsoft.com/<your-organization> |
| 54 | +``` |
| 55 | + |
| 56 | +> [!NOTE] |
| 57 | +> The demo server is for testing purposes only. Use any organization name — it acts as a namespace to group your devices. |
| 58 | +
|
| 59 | + |
47 | 60 |
|
48 | 61 | --- |
49 | 62 |
|
@@ -81,26 +94,10 @@ cd ios && pod install && cd .. |
81 | 94 | npx react-native run-ios |
82 | 95 | ``` |
83 | 96 |
|
84 | | -### Release builds |
85 | | - |
86 | | -```bash |
87 | | -npx react-native run-android --mode=release |
88 | | -npx react-native run-ios --mode Release |
89 | | -``` |
90 | | - |
91 | | ---- |
92 | | - |
93 | | -## Which Should I Use? |
94 | | - |
95 | | -- Start with **HelloWorld** if you want to understand the basics quickly. |
96 | | -- Use **Advanced** if you want to explore the SDK’s full capabilities and UI |
97 | | - patterns. |
98 | | - |
99 | 97 | --- |
100 | 98 |
|
101 | 99 | ## Learn More |
102 | 100 |
|
103 | | -- Documentation: |
104 | | - https://transistorsoft.github.io/react-native-background-geolocation/latest/ |
105 | | -- GitHub repository: |
106 | | - https://github.com/transistorsoft/react-native-background-geolocation |
| 101 | +- [Documentation](https://docs.transistorsoft.com/typescript/setup/) |
| 102 | +- [API Reference](https://docs.transistorsoft.com/typescript/BackgroundGeolocation/) |
| 103 | +- [GitHub repository](https://github.com/transistorsoft/react-native-background-geolocation) |
0 commit comments