@neosyn-ee/neos-native-kit NPM

React Native Core

Features

Developer experience first:

⚛️ React Native for building native apps using React
🔥 Type checking TypeScript
📏 Linter with ESLint
💖 Code Formatter with Prettier
🦊 Husky for Git Hooks
🚫 Lint-staged for running linters on Git staged files
🦺 Unit Testing with Jest and React Testing Library
🧪 E2E Testing with Detox
🗂 VSCode configuration: Settings, Tasks and extension for ESLint, Prettier, TypeScript, Jest

Requirements

Node.js 14+ and yarn
Java jdk
iOS Simulator
Android Studio Emulator

For more information: React Native setup

Getting started

Run the following command on your local environment:

git clone
cd my-project-name
yarn install

Then, you can run locally in development mode with live reload:

yarn run start
yarn run android
# Or
yarn run ios

Storybook

An example how to add a separate JS bundle entry point for RN Storybook and how to switch between entry points from the Dev Menu:

A separate entry point helps to ensure that application's bundle won't include any Storybook code.

Also switching between Storybook and app is very straightforward and convenient and it's possible to keep the app and Storybook open in different Simulators / Emulators at the same time.

How to use

Check this diff: https://github.com/zubko/react-native-storybook-with-dev-menu/commit/7486060842a15d12ecdd5256f2fb0ddddc7e0e32

Generally the process is: 1. Add Storybook JS bundle entry point 2. For Android and iOS: Add extra files to the native projects Change the existing native files

Thoughts

Probably it should be possible to move the code to a separate NPM package to make the integration a bit easier, but I'm lacking some knowledge of native Android module part of RN to get the DevSupportManager instance and application context in the module at the proper moment of time when they are constructed, so any suggestions are welcome.

Anyways, the decision of the JS entry point happens in the native app's code, so some manual changes to the native code of the app will be needed in any case.

Testing

Testing is an important part of the development process and often the neglected one. This starter code comes up with Jest and React Testing Library for unit testing and Detox for E2E testing.

Unit Testing

To run the unit tests, run the following command:

npm run test

E2E Testing

To run the E2E tests, you first need to run the following command:

Then, you can run the following command to run the E2E tests:

npm run e2e:ios
# Or
npm run e2e:android

Library Usage Guide

Global Dependencies

twrnc

Components

VideoPlayer

Dependencies

VirtualizedList

react-native-reanimated ^3.5.2

IMPORTANT: Ensure to add the following code inside your babel.config.js file to properly configure the React Native Reanimated plugin:

module.exports = {
  plugins: ['react-native-reanimated/plugin'],
};

Android Permissions

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />