relay-ota-react-native 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,11 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
**Over-the-air updates for React Native — ship JS bundle changes instantly, without App Store review.**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Drop-in replacement for the retired Microsoft CodePush and an alternative to Expo EAS Updates.
|
|
6
6
|
|
|
7
7
|
[](https://www.npmjs.com/package/relay-ota-react-native)
|
|
8
8
|
[](https://www.npmjs.com/package/relay-ota-react-native)
|
|
9
|
-
[](https://github.com/aglaonematech/relay-ota-react-native/blob/main/LICENSE)
|
|
10
9
|
[](https://github.com/aglaonematech/relay-ota-react-native)
|
|
11
10
|
|
|
12
11
|
**Website:** [relayota.com](https://relayota.com) · **Docs:** [relayota.com/docs](https://relayota.com/docs) · **GitHub:** [aglaonematech/relay-ota-react-native](https://github.com/aglaonematech/relay-ota-react-native)
|
|
@@ -15,7 +14,7 @@ Open-source drop-in replacement for the retired Microsoft CodePush and a self-ho
|
|
|
15
14
|
|
|
16
15
|
## What is Relay OTA?
|
|
17
16
|
|
|
18
|
-
Relay OTA lets you push JavaScript bundle updates directly to your users' devices — no App Store or Play Store review needed.
|
|
17
|
+
Relay OTA lets you push JavaScript bundle updates directly to your users' devices — no App Store or Play Store review needed.
|
|
19
18
|
|
|
20
19
|
- **Zero review wait** — critical fixes reach users in seconds
|
|
21
20
|
- **One-click rollback** — bad update? revert instantly from the dashboard
|
|
@@ -61,7 +60,7 @@ export default function App() {
|
|
|
61
60
|
<OtaProvider
|
|
62
61
|
fileSystem={fs}
|
|
63
62
|
config={{
|
|
64
|
-
serverUrl: 'https://ota.yourcompany.com', // your
|
|
63
|
+
serverUrl: 'https://ota.yourcompany.com', // your Relay OTA server URL
|
|
65
64
|
appId: 'YOUR_APP_ID',
|
|
66
65
|
channel: 'production',
|
|
67
66
|
platform: 'IOS', // or 'ANDROID'
|
|
@@ -136,27 +135,11 @@ Bare React Native requires the `OtaBundleUpdater` native module — see [Native
|
|
|
136
135
|
|
|
137
136
|
---
|
|
138
137
|
|
|
139
|
-
## Self-hosting the server
|
|
140
|
-
|
|
141
|
-
This SDK connects to a **Relay OTA server** you run yourself. Getting the server up takes about 5 minutes:
|
|
142
|
-
|
|
143
|
-
```sh
|
|
144
|
-
git clone https://github.com/aglaonematech/relay-ota.git
|
|
145
|
-
cd relay-ota
|
|
146
|
-
docker compose up -d # starts Postgres, Redis, MinIO
|
|
147
|
-
npm install
|
|
148
|
-
npm run dev
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
Full setup guide → [relayota.com/docs](https://relayota.com/docs)
|
|
152
|
-
|
|
153
|
-
---
|
|
154
|
-
|
|
155
138
|
## OtaProvider config
|
|
156
139
|
|
|
157
140
|
| Prop | Type | Required | Description |
|
|
158
141
|
|------|------|----------|-------------|
|
|
159
|
-
| `serverUrl` | `string` | ✅ | Base URL of your OTA server |
|
|
142
|
+
| `serverUrl` | `string` | ✅ | Base URL of your Relay OTA server |
|
|
160
143
|
| `appId` | `string` | ✅ | App ID from the OTA dashboard |
|
|
161
144
|
| `channel` | `string` | ✅ | Release channel — e.g. `'production'`, `'staging'` |
|
|
162
145
|
| `platform` | `'IOS' \| 'ANDROID'` | ✅ | Target platform |
|
|
@@ -352,9 +335,7 @@ Microsoft retired CodePush in 2025. Relay OTA uses the same update model and a c
|
|
|
352
335
|
|
|
353
336
|
| | CodePush | Relay OTA |
|
|
354
337
|
|---|---|---|
|
|
355
|
-
| Hosting | Vendor (shut down) |
|
|
356
|
-
| Source | Closed | Open source (MIT) |
|
|
357
|
-
| Cost | Was paid | Free forever |
|
|
338
|
+
| Hosting | Vendor (shut down) | Relay OTA platform |
|
|
358
339
|
| Rollback | Yes | Yes |
|
|
359
340
|
| Analytics | Basic | Built-in, detailed |
|
|
360
341
|
| Staged rollouts | Yes | Yes |
|
|
@@ -368,9 +349,3 @@ Microsoft retired CodePush in 2025. Relay OTA uses the same update model and a c
|
|
|
368
349
|
- **GitHub:** [github.com/aglaonematech/relay-ota-react-native](https://github.com/aglaonematech/relay-ota-react-native)
|
|
369
350
|
- **npm:** [relay-ota-react-native](https://www.npmjs.com/package/relay-ota-react-native)
|
|
370
351
|
- **Issues:** [github.com/aglaonematech/relay-ota-react-native/issues](https://github.com/aglaonematech/relay-ota-react-native/issues)
|
|
371
|
-
|
|
372
|
-
---
|
|
373
|
-
|
|
374
|
-
## License
|
|
375
|
-
|
|
376
|
-
MIT — see [LICENSE](https://github.com/aglaonematech/relay-ota-react-native/blob/main/LICENSE)
|