React Native Superwall

https://github.com/superwall/react-native-superwall.git
Admin
Superwall is an open-source framework for React Native that simplifies presenting and creating...
Tokens:2,603
Snippets:12
Trust Score:9.3
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Metro Bundler

Source: https://github.com/superwall/react-native-superwall.git/blob/main/example/README.md

Starts the Metro JavaScript bundler, which is essential for developing React Native applications. This command should be run from the root of your project directory.

```npm
npm start
```

```yarn
yarn start
```

--------------------------------

### Start Example App Packager

Source: https://github.com/superwall/react-native-superwall.git/blob/main/CONTRIBUTING.md

Starts the Metro server for the example application. This packager is required to run the example app on a simulator or device.

```shell
yarn example start
```

--------------------------------

### Reload App Changes

Source: https://github.com/superwall/react-native-superwall.git/blob/main/example/README.md

Instructions for reloading the application to see code modifications. This can be done via keyboard shortcuts or the developer menu.

```android-developer-menu
Press the <kbd>R</kbd> key twice or select "Reload" from the Developer Menu (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⎛⎜</kbd> + <kbd>M</kbd> (on macOS))
```

```ios-simulator
Hit <kbd>Cmd ⎛⎜</kbd> + <kbd>R</kbd> in your iOS Simulator
```

--------------------------------

### Run React Native App on iOS

Source: https://github.com/superwall/react-native-superwall.git/blob/main/example/README.md

Builds and launches the React Native application on an iOS simulator or connected device. Ensure Metro bundler is running in a separate terminal.

```npm
npm run ios
```

```yarn
yarn ios
```

--------------------------------

### Run React Native App on Android

Source: https://github.com/superwall/react-native-superwall.git/blob/main/example/README.md

Builds and launches the React Native application on an Android emulator or connected device. Ensure Metro bundler is running in a separate terminal.

```npm
npm run android
```

```yarn
yarn android
```

--------------------------------

### Run Example App on iOS

Source: https://github.com/superwall/react-native-superwall.git/blob/main/CONTRIBUTING.md

Builds and runs the example application on an iOS simulator or device. Requires Xcode and CocoaPods to be installed and configured.

```shell
yarn example ios
```

--------------------------------

### Run Example App on Android

Source: https://github.com/superwall/react-native-superwall.git/blob/main/CONTRIBUTING.md

Builds and runs the example application on an Android device or emulator. Ensure your Android development environment is correctly configured.

```shell
yarn example android
```

--------------------------------

### Install Project Dependencies with Yarn

Source: https://github.com/superwall/react-native-superwall.git/blob/main/CONTRIBUTING.md

Installs all project dependencies using Yarn workspaces. This command is essential for setting up the monorepo and preparing for development.

```shell
yarn
```

--------------------------------

### Publish New Versions with Release-it

Source: https://github.com/superwall/react-native-superwall.git/blob/main/CONTRIBUTING.md

Automates the process of publishing new versions to npm. This includes version bumping, tag creation, and release generation.

```shell
yarn release
```

--------------------------------

### Run Unit Tests with Jest

Source: https://github.com/superwall/react-native-superwall.git/blob/main/CONTRIBUTING.md

Executes the project's unit tests using Jest. It is recommended to add tests for any new changes or bug fixes.

```shell
yarn test
```

--------------------------------

### Verify Code Quality with TypeScript and ESLint

Source: https://github.com/superwall/react-native-superwall.git/blob/main/CONTRIBUTING.md

Runs TypeScript for type checking and ESLint for linting the codebase. These commands ensure code quality and consistency.

```shell
yarn typecheck
yarn lint
```

--------------------------------

### Fix Formatting Errors with ESLint

Source: https://github.com/superwall/react-native-superwall.git/blob/main/CONTRIBUTING.md

Automatically fixes formatting errors detected by ESLint. This command helps maintain code style consistency across the project.

```shell
yarn lint --fix
```
Tokens:
Raw