@nuskin/ns-login-react-native

Nu Skin Login Module for React Native

Usage no npm install needed!

<script type="module">
  import nuskinNsLoginReactNative from 'https://cdn.skypack.dev/@nuskin/ns-login-react-native';
</script>

README

Login Module

Nu Skin Login Module

Installation

npm install ns-login-react-native

Usage

import NsLoginReactNative from "ns-login-react-native";

// ...

const result = await NsLoginReactNative.multiply(3, 7);

Development workflow

Before attempting to install and run the example program, there are 2 authentication files that are required. It is recommended for developement to use the NuSkin Test environment (vs Dev) so you will require the following files:

oktaConfigurationTest.ts which needs to be added to the example/src directory.

Configuration.ts which needs to be added to the src directory.

Once the configuration files are in place, to get started with the project, run yarn in the root directory to install the required dependencies for each package:

yarn

While it's possible to use npm, the tooling is built around yarn, so you'll have an easier time if you use yarn for development.

While developing, you can run the example app to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.

To start the packager:

yarn example start

To run the example app on Android:

yarn example android

To run the example app on iOS:

yarn example ios

To run the example app on Web:

yarn example web

To sign in you will need an account in the Nu Skin Test environment. If you do not already have an account, you can sign up at the Nu Skin test server

Make sure your code passes TypeScript and ESLint. Run the following to verify:

yarn typescript
yarn lint

To fix formatting errors, run the following:

yarn lint --fix

Remember to add tests for your change if possible. Run the unit tests by:

yarn test

Linting and tests

ESLint, Prettier, TypeScript

We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, and Jest for testing.

Our pre-commit hooks verify that the linter and tests pass when committing.

Scripts

The package.json file contains various scripts for common tasks:

  • yarn bootstrap: setup project by installing all dependencies and pods.
  • yarn typescript: type-check files with TypeScript.
  • yarn lint: lint files with ESLint.
  • yarn test: run unit tests with Jest.
  • yarn example start: start the Metro server for the example app.
  • yarn example android: run the example app on Android.
  • yarn example ios: run the example app on iOS.

License

MIT