Merge pull request #81 from PlayerData/expo

refactor: Switching to Expo

Author: Koalk

.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  root: true,
+  extends: ['universe/native', 'universe/web'],
+  ignorePatterns: ['build'],
+};

.github/workflows/build_and_release.yml

@@ -20,10 +20,10 @@ jobs:
           node-version: 18
 
       - name: Install dependencies
-        run: yarn install
+        run: npm install
 
       - name: Build
-        run: yarn build
+        run: npm run build
 
       - name: Release
         env:

.github/workflows/lint.yml

@@ -18,13 +18,11 @@ jobs:
           node-version: 18
 
       - name: Install package dependencies
-        run: yarn install
-      
+        run: npm install
+
       - name: Install example app dependencies
-        run: yarn example install
+        working-directory: ./example
+        run: npm install
 
       - name: Lint
-        run: yarn lint
-
-      - name: Typecheck
-        run: yarn typecheck
+        run: npm run lint

.gitignore

@@ -2,9 +2,6 @@
 #
 .DS_Store
 
-# XDE
-.expo/
-
 # VSCode
 .vscode/
 jsconfig.json
@@ -31,30 +28,30 @@ project.xcworkspace
 
 # Android/IJ
 #
-.idea
+.classpath
+.cxx
 .gradle
+.idea
+.project
+.settings
 local.properties
 android.iml
+android/app/libs
+android/keystores/debug.keystore
 
 # Cocoapods
 #
 example/ios/Pods
 
+# Ruby
+example/vendor/
+
 # node.js
 #
 node_modules/
 npm-debug.log
 yarn-debug.log
 yarn-error.log
 
-# BUCK
-buck-out/
-\.buckd/
-android/app/libs
-android/keystores/debug.keystore
-
 # Expo
 .expo/*
-
-# generated by bob
-lib/

.npmignore

@@ -0,0 +1,11 @@
+# Exclude all top-level hidden directories by convention
+/.*/
+
+__mocks__
+__tests__
+
+/babel.config.js
+/android/src/androidTest/
+/android/src/test/
+/android/build/
+/example/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 PlayerData Holdings Ltd
+Copyright (c) 2023 PlayerData Holdings Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,10 +1,34 @@
-# react-native-mcu-manager
+# @playerdata/react-native-mcu-manager
 
-MCUMgr DFU from React Native.
+React Native Wrappers for MCUMgr's Android / iOS client libraries
 
-## Getting started
+# Getting started
+
+## Installation in managed Expo projects
+
+For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects,
+we hope this will Just Work :tm:.
+
+The example app uses Expo Prebuild, so we've some confidence, but let us know
+how you get on.
+
+## Installation in bare React Native projects
+
+For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
+
+### Add the package to your npm dependencies
+
+```
+npm install @playerdata/react-native-mcu-manager
+```
+
+### Configure for iOS
+
+Run `npx pod-install` after installing the npm package.
+
+
+### Configure for Android
 
-`$ npm install @playerdata/react-native-mcu-manager --save`
 ## Usage
 ```ts
 import McuManager, { ProgressEvent, UploadEvents } from '@playerdata/react-native-mcu-manager';
@@ -24,57 +48,52 @@ UploadEvents.addListener('uploadStateChanged', onUploadStateChanged);
 McuManager.updateDevice(bluetoothId, fileUri)
 ```
 
-## Contributing
+# Contributing
 
-### Development workflow
+Contributions are very welcome!
 
-To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
+There are many examples of expo modules in the expo repo packages like
+https://github.com/expo/expo/blob/main/packages/expo-camera/README.md
 
-```sh
-yarn install
-yarn example install
-yarn example pods
-```
+## Development Workflow
 
-While developing, you can run the [example app](/example/) to test your changes.
+Install dependencies:
 
-To start the packager:
-
-```sh
-yarn example start
+```
+npm install
 ```
 
-To run the example app on Android:
+You should use the example app to test your changes:
 
-```sh
-yarn example android
 ```
+cd example
 
-To run the example app on iOS:
-
-```sh
-yarn example ios
+npx expo prebuild
 ```
 
+From the top level of the repo, you can use `npm run open:(ios|android)` to open
+the appropriate IDE.
+
+For Swift files, you'll find the source files at `Pods > Development Pods > ReactNativeMcuManager`
+in XCode.
+
+For Kotlin, you'll find the source files at `reactnativemcumanager` under `Android` in Android Studio.
+
 Make sure your code passes TypeScript and ESLint. Run the following to verify:
 
 ```sh
-yarn typecheck
-yarn lint
+npm run typecheck
+npm run lint
 ```
 
 To fix formatting errors, run the following:
 
 ```sh
-yarn lint --fix
+npm run lint --fix
 ```
 
-Remember to add tests for your change if possible. Run the unit tests by:
+Remember to add unit tests for your change if possible. Run the unit tests by:
 
 ```sh
-yarn test
+npm run test
 ```
-
-To edit the Swift files, open `example/ios/McuManagerExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-mcu-manager`.
-
-To edit the Kotlin files, open `example/android` in Android studio and find the source files at `reactnativemcumanager` under `Android`.