rampkit-expo-dev 0.0.3 → 0.0.4
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 +92 -0
- package/package.json +26 -1
- package/.expo/README.md +0 -13
- package/.expo/devices.json +0 -3
package/README.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://rampkit-images.s3.amazonaws.com/logo.png" height="80" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">RampKit Expo SDK</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">Build, test, and improve your onboarding experience with instant updates.</p>
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## What is RampKit?
|
|
12
|
+
|
|
13
|
+
RampKit lets you create, edit, and deploy onboarding flows from the web. No new releases. No code changes. You design your onboarding in the RampKit dashboard and the Expo SDK handles the rest.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Features
|
|
18
|
+
|
|
19
|
+
- Visual web builder
|
|
20
|
+
- A/B testing
|
|
21
|
+
- Personalized onboardings
|
|
22
|
+
- Instant updates
|
|
23
|
+
- Analytics and insights
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Installation
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
npx expo install rampkit-expo-dev
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Setup
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
import { RampKit } from "rampkit-expo-dev";
|
|
39
|
+
|
|
40
|
+
RampKit.configure({
|
|
41
|
+
projectId: "YOUR_PROJECT_ID",
|
|
42
|
+
});
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Show an onboarding:
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
await RampKit.present();
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Configuration Options
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
RampKit.configure({
|
|
57
|
+
projectId: "abc123",
|
|
58
|
+
userId: "user_42", // optional
|
|
59
|
+
debug: true, // optional
|
|
60
|
+
});
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
More examples are in the docs:
|
|
64
|
+
https://rampkit.com/docs
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Example
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
import { RampKit } from "rampkit-expo-dev";
|
|
72
|
+
import { Button } from "react-native";
|
|
73
|
+
|
|
74
|
+
export default function App() {
|
|
75
|
+
return <Button title="Show Onboarding" onPress={() => RampKit.present()} />;
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Links
|
|
82
|
+
|
|
83
|
+
- Website: https://rampkit.com
|
|
84
|
+
- Docs: https://rampkit.com/docs
|
|
85
|
+
- GitHub: https://github.com/getrampkit/rampkit-expo
|
|
86
|
+
- Issues: https://github.com/getrampkit/rampkit-expo/issues
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## License
|
|
91
|
+
|
|
92
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,8 +1,33 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rampkit-expo-dev",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
4
|
+
"description": "The Expo SDK for RampKit. Build, test, and personalize app onboardings with instant updates.",
|
|
4
5
|
"main": "build/index.js",
|
|
5
6
|
"types": "build/index.d.ts",
|
|
7
|
+
"homepage": "https://rampkit.com",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "https://github.com/getrampkit/rampkit-expo"
|
|
11
|
+
},
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/getrampkit/rampkit-expo/issues"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"onboarding",
|
|
17
|
+
"expo",
|
|
18
|
+
"react-native",
|
|
19
|
+
"a/b testing",
|
|
20
|
+
"rampkit",
|
|
21
|
+
"mobile onboarding",
|
|
22
|
+
"marchitectures",
|
|
23
|
+
"sdk"
|
|
24
|
+
],
|
|
25
|
+
"author": "RampKit",
|
|
26
|
+
"license": "MIT",
|
|
27
|
+
"files": [
|
|
28
|
+
"build",
|
|
29
|
+
"README.md"
|
|
30
|
+
],
|
|
6
31
|
"scripts": {
|
|
7
32
|
"build": "tsc",
|
|
8
33
|
"watch": "tsc --watch --preserveWatchOutput"
|
package/.expo/README.md
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
> Why do I have a folder named ".expo" in my project?
|
|
2
|
-
|
|
3
|
-
The ".expo" folder is created when an Expo project is started using "expo start" command.
|
|
4
|
-
|
|
5
|
-
> What do the files contain?
|
|
6
|
-
|
|
7
|
-
- "devices.json": contains information about devices that have recently opened this project. This is used to populate the "Development sessions" list in your development builds.
|
|
8
|
-
- "settings.json": contains the server configuration that is used to serve the application manifest.
|
|
9
|
-
|
|
10
|
-
> Should I commit the ".expo" folder?
|
|
11
|
-
|
|
12
|
-
No, you should not share the ".expo" folder. It does not contain any information that is relevant for other developers working on the project, it is specific to your machine.
|
|
13
|
-
Upon project creation, the ".expo" folder is already added to your ".gitignore" file.
|
package/.expo/devices.json
DELETED