react-native-signup-majors-solutions

This package contains the signup journey components for Majors Solutions app. It includes screens and functionalities required for handling user signup, verification, and profile setup.

Table of Contents

• Installation
• Usage
• Components
• Development and Testing
• Configuration for Local Testing with Expo
• License

Installation

To install react-native-signup-majors-solutions in your React Native project, run:

npm install react-native-signup-majors-solutions

Peer Dependencies

This package requires react and react-native as peer dependencies. Ensure they are installed in your project:

npm install react react-native

Usage

Import and use the components from the package in your React Native application. Here’s a basic setup:

import { PhoneInput, VerificationCode, PersonalInfo, Username } from 'react-native-signup-majors-solutions';

export default function SignupJourney() {
  return (
    <Stack.Navigator screenOptions={{ headerShown: false }}>
      <Stack.Screen name="PhoneInput" component={PhoneInput} />
      <Stack.Screen name="VerificationCode" component={VerificationCode} />
      <Stack.Screen name="PersonalInfo" component={PersonalInfo} />
      <Stack.Screen name="Username" component={Username} />
    </Stack.Navigator>
  );
}

Components

The package includes the following components:

• PhoneInput: Initial phone number input screen.
• VerificationCode: Verification screen for OTP code input.
• PersonalInfo: Screen for collecting user personal information.
• Username: Screen for setting up the user’s unique username.

Each component is designed to fit into a react-navigation stack and is styled for seamless integration into a React Native app.

Development and Testing

When developing and testing locally, you might want to run the project using Expo for faster testing and hot reloading. Follow the steps below for local testing.

Configuration for Local Testing with Expo

By default, the "main" field in package.json is set to "dist/cjs/index.js", which is necessary for production and distribution through NPM. However, if you want to run the repository locally using Expo, you need to modify this path.

1. Open the package.json file.

2. Change the "main" field to point to the Expo entry file:

   "main": "node_modules/expo/AppEntry.js",

3. Install Expo if it is not installed globally:

   npm install -g expo-cli

4. Start the Expo server:

   expo start

Reverting to Production Setup

Once you are finished with local testing and ready to publish, change the "main" field back to "dist/cjs/index.js":

"main": "dist/cjs/index.js",

This ensures that your package is correctly configured for use as a library.

License

This project is licensed under the ISC License - see the LICENSE file for details.