@twinmatrix/spatialverse-sdk-rn 0.1.0
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 +42 -0
- package/lib/cjs/index.js +30 -0
- package/lib/cjs/index.js.map +1 -0
- package/lib/esm/index.js +30 -0
- package/lib/esm/index.js.map +1 -0
- package/package.json +127 -0
- package/typings/index.d.ts +68 -0
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# MetaAtlasSDK
|
|
2
|
+
|
|
3
|
+
Only use `yarn` and avoid using `npm` as peer dependencies are used.
|
|
4
|
+
|
|
5
|
+
## Repository Setup
|
|
6
|
+
The SDK code is divided into two repositories, the platform specific code for each SDK & the core code which is common for all platforms.
|
|
7
|
+
1. The platform specific code is in this repository, branch `web` & `react-native` have the latest state for each platform.
|
|
8
|
+
2. `SDK Core` repository has common code.
|
|
9
|
+
|
|
10
|
+
### SDK Core Subtree setup
|
|
11
|
+
`SDK Core` is used as a git subtree in this main repository, below are the steps to setup it as a subtree.
|
|
12
|
+
1. git remote add metaAtlasCore https://gitlab.com/twinmatrix/atoms-legacy/sdk-core.git
|
|
13
|
+
#### React Native
|
|
14
|
+
1. git subtree add --prefix=src/meta-atlas-sdk-rn/MetaAtlasCore/ metaAtlasCore main --squash
|
|
15
|
+
#### Web
|
|
16
|
+
1. git subtree add --prefix=src/meta-atlas-sdk/MetaAtlasCore/ metaAtlasCore main --squash
|
|
17
|
+
|
|
18
|
+
### SDK Core Subtree sync changes
|
|
19
|
+
#### Push to SDK Core
|
|
20
|
+
##### React Native
|
|
21
|
+
1. git subtree push --prefix=src/meta-atlas-sdk-rn/MetaAtlasCore/ metaAtlasCore main
|
|
22
|
+
##### Web
|
|
23
|
+
1. git subtree push --prefix=src/meta-atlas-sdk/MetaAtlasCore/ metaAtlasCore main
|
|
24
|
+
|
|
25
|
+
#### Pull from SDK Core
|
|
26
|
+
##### React Native
|
|
27
|
+
1. git fetch metaAtlasCore main
|
|
28
|
+
2. git subtree pull --prefix=src/meta-atlas-sdk-rn/MetaAtlasCore/ metaAtlasCore main --squash
|
|
29
|
+
##### Web
|
|
30
|
+
1. git fetch metaAtlasCore main
|
|
31
|
+
2. git subtree pull --prefix=src/meta-atlas-sdk/MetaAtlasCore/ metaAtlasCore main --squash
|
|
32
|
+
|
|
33
|
+
## Generate Build
|
|
34
|
+
Run `npm run build:bundles` to generate the build files.
|
|
35
|
+
Generated build files are under lib/bundles.
|
|
36
|
+
|
|
37
|
+
### Instructions for end user
|
|
38
|
+
NOTE: Any react native application that uses MetaAtlasSDK must have the following packages installed else the SDK will fail to load.
|
|
39
|
+
1. @maplibre/maplibre-react-native
|
|
40
|
+
2. react
|
|
41
|
+
3. react-native
|
|
42
|
+
4. axios
|