brew-react-native-kit
v1.1.3
Published
Boilerplate for react native project
Downloads
148
Maintainers
Readme
BrewRNKit
⚛️ React Native Boilerplate: Jumpstart your app development with essential configurations for React Native projects. Includes libraries, navigation, state management, and styling setup. Streamline your workflow and focus on building amazing mobile experiences! 📱✨
📱 Screenshot
Preview of myapp
https://github.com/CodeBrewLabs7/myapp/assets/56266123/e9a51ea0-f056-4b14-b4ef-f01eef8cc7de
Key Features
- Handle Light/Dark Mode: Built-in support for toggling between light and dark modes.
- Localization: Easily localize your app with internationalization support.
- Global State Management: Integration with Redux Toolkit for managing global state.
- Async Data Fetching: Utilize @tanstack/react-query for efficient asynchronous data fetching.
- Authentication Stack: Boilerplate includes authentication stack for user authentication.
- Main Stack: Configured main stack for navigation and UI structure.
- And Many More: Additional features and configurations to streamline development.
Quick Start ⚡
To create a new project using the boilerplate simply run :
npx react-native@latest init MyApp --template brew-react-native-kit
Libraries Using BrewRNKit 📚
- @react-navigation/native
- react-native-screens
- react-native-safe-area-context
- @react-navigation/native-stack
- react-native-mmkv
- react-native-masked-view
- react-native-gesture-handler
- react-redux
- @reduxjs/toolkit
- @tanstack/react-query
- i18next
- @os-team/i18next-react-native-language-detector
- intl-pluralrules
- react-i18next
- axios
- @testing-library/react-native
- react-native-keyboard-aware-scroll-view
- react-native-reanimated
- react-native-restart
- react-native-unistyles
Requirements
Node 18 or greater is required. Development for iOS requires a Mac and Xcode 10 or up, and will target iOS 11 and up.
You also need to install the dependencies required by React Native.
Go to the React Native environment setup, then select React Native CLI Quickstart
tab.
Follow instructions for your given development OS
and target OS
.
Getting Started
Note: Make sure you have completed the React Native - Environment Setup instructions till "Creating a new application" step, before proceeding.
Step 1: Start the Metro Server
First, you will need to start Metro, the JavaScript bundler that ships with React Native.
To start Metro, run the following command from the root of your React Native project:
# using npm
npm install
npm start
# OR using Yarn
yarn install
yarn start
Step 2: Start your Application
Let Metro Bundler run in its own terminal. Open a new terminal from the root of your React Native project. Run the following command to start your Android or iOS app:
For Android
# using npm
npm run android
# OR using Yarn
yarn android
For iOS
# using npm
cd ios
pod install
npm run ios
# OR using Yarn
cd ios
pod install
yarn ios
Acknowledgements
This package was inspired by theCodingMachine's React Native Boilerplate. We drew inspiration from their project architecture and design principles, adapting them to suit our specific needs. We are grateful for their contributions to the React Native community.