@purrseus/react-native-template

🌱 React Native Template

Clean, efficient, and scalable React Native template with pre-configured common set of packages to quick-start a new app.

🔖 Table Of Contents

• Key Features
• Requirements
• Usage
• Setup
• Troubleshooting
• Project Structure
• Scripts
• License

🌟 Key Features

• Using Typescript
• Folder-by-feature structure
• Dark mode support
• A minimal UI kit built with tailwindcss
• Internationalization framework using I18next
• Lint commit messages using Commitlint
• Multiple environment configurations using React Native Config
• Client-state management using Zustand
• Server-state management using React Query
• Local storage using MMKV
• Routing and navigation using React Navigation
• API requests using Axios
• Debug tool using Flipper
• Schema validation using Zod
• OTA update using CodePush
• FlashList, React Native Reanimated, React Native Gesture Handler and more

❕ Requirements

Make sure that you have followed the environment setup instructions properly from the official React Native docs.

⚡ Usage

npx react-native init MyApp --template @purrseus/react-native-template

⚙️ Setup

Run setup command:

yarn setup

CodePush Setup:

If you don't use CodePush, you can skip this setup guide.

1. Open up scripts/utils.mjs, replace appCenter.ownerName value with your owner name, and replace appCenter.appName values with your app names.

2. Add App Secret Key and Code Push Deployment Key into AppCenter variables in your environments/.env.* files.

3. Run this command to create AppCenter config file for both platform directories:

yarn setup:code-push

Android Setup:

1. Go to android/app, generate a keystore file:

sudo keytool -genkey -v -keystore development.keystore -alias my-key-alias -keyalg RSA -keysize 2048 -validity 10000
# replace "development" for your environment, and replace "my-key-alias" for your alias

Warning If you build android app in a specific environment without corresponding keystore, you will get a error that you are missing a keystore.

2. In environments/.env.* files, edit ANDROID_STORE_PASSWORD, ANDROID_KEY_ALIAS and ANDROID_KEY_PASSWORD values to your selected values in the keystore file.

iOS Setup:

No additional steps are necessary.

🛠️ Troubleshooting

Once again, make sure that you have followed the environment setup instructions properly from the official docs.

Problems with Ruby versions

This error seems to originate from the CLI, it has problems comparing between the global Ruby version on your local machine and the Ruby version requested in the Gemfile file. To fix this error, try to reinstall the dependencies following the steps below:

1. cd <project-name> to navigate to your RN project.
2. bundle install to install Bundler
3. cd ios && bundle exec pod install to install the iOS dependencies.

🌳 Project Structure

See Project Structure.

📃 Scripts

See Available Scripts.

📄 License

This project is MIT licensed.