README.md

🚀 Quai Mobile Development Kit - React Native

The Quai Mobile Development Kit (MDK) is a feature driven architecture starter project with a Quai and QI wallet and payment rails to enable rapid POC and MVP development of your mobile application. This project is configured with redux, redux saga and redux persist. Uses latest version of react-navigation.

Scalability Factor

This Type based Architecture scales smoothly for different sized apps using feature based architecture.

Features

• Typescript support.
• React Hooks
• React Navigation with Authentication flow baked in & theming support.
• React Native Gesture Handler
• Redux with hooks support
• Redux Saga
• Redux Persist
• Jest
• Eslint (Airbnb config)

Prerequisites

• Node v18+ (it is recommended to install it via NVM)
• Yarn
• A development machine set up for React Native by following these instructions

Getting Started

1. Clone this repo, git clone https://https://github.com/dominant-strategies/quai-mobile-development-kit.git <your project name>

2. Go to project's root directory, cd <your project name>

3. Remove .git folder, rm -rf .git

4. Use React Native Rename to update project name $ npx react-native-rename <newName>

5. Run yarn to install dependencies and cd ios then pod install

6. For IOS, build the app in XCode, Start the packager with yarn start

7. Connect a mobile device to your development machine

8. Run the application:

• On Android:
  • Run react-native run-android or Use Android Studio (Recommended)
• On iOS:
  • Open ios/YourReactProject.xcworkspace in Xcode
  • Hit Run after selecting the desired device

9. Happy Coding with Quai Mobile Development Kit!

Contributing

PRs are welcome!