# react-native-rust-module

> React Native Rust module

Latest version **0.1.1** (published 2022-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-rust-module
pnpm add react-native-rust-module
yarn add react-native-rust-module
bun add react-native-rust-module
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2022-05-30 |
| First published | 2022-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 43.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Author | Laurenz Honauer |
| Maintainers | laurenz.honauer |
| Keywords | react-native, ios, android, rust, |

## Links

- npm: https://www.npmjs.com/package/react-native-rust-module
- Repository: https://github.com/lauhon/react-native-rust-module
- Homepage: https://github.com/lauhon/react-native-rust-module#readme
- Issues: https://github.com/lauhon/react-native-rust-module/issues
- npm.io page: https://npm.io/package/react-native-rust-module

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2022-05-30
- 0.1.0 — 2022-05-30

## README

# react-native-rust-module

Boilerplate to create react native modules relying on rust

# Instructions

In the Example is a react native project that is configured to automatically consume a react-native-rust module that provides
a helloWorld method which will call rust a rust library in both android and ios.

The rust library can be found in the rust/signer/src/lib.rs file

## Requirements

Node - tested on 16
Android Toolchain (Android Studio)
iOs Toolchain (xCode)
Rust Toolchain - Cargo, rustup... (https://rustup.rs/ to get started)

### Install Node Modules

1. `yarn` or `npm i`
2. `cd example`

## iOs

To Perform changes and run those in ios follow these steps

1. `yarn` or `npm i`
2. `cd /ios`
3. `pod install`

### Change Rust

1. modify lib.rs (if you add extra methods you also have to edit the signer.h file)
2. `cd rust/signer` and `make ios` - this will create a new file libsigner.a in the rust/signer directory
3. replace the old libsigner.a in ios/libs with the generated file
4. Run the app (in xcode or with `npm run ios`)

## Android

To Perform changes and run those in ios follow these steps

### Change Rust

1. modify lib.rs (if you add extra methods you also have to edit the signer.h file)
2. `cd rust/signer` and `make android` - this will create a new file libsigner.a in the rust/signer directory
3. `make android` will also have started the script `copy_android` which should have copied the rust compilation results into
   the java project.

(If the `make android` command throws an error that is complaining about missing -lgcc look at [this issue](https://github.com/fzyzcjy/flutter_rust_bridge/issues/419) ) 4. Run the app (in Android studio or with `npm run android`)

# Kudos

Heavily inspired by

https://github.com/paritytech/parity-signer/tree/legacy-4.5.3
https://robertohuertas.com/2019/10/27/rust-for-android-ios-flutter/

---
_Source: https://npm.io/package/react-native-rust-module · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._