This project is a React Native template designed to accelerate development by providing essential features such as state management, internationalization, data fetching, navigation, and reusable components.
Created using the default components provided in the project.
-
🌍 Internationalization (i18n)
- Multi-language support using
react-i18next
for seamless localization.
- Multi-language support using
-
🗃️ State Management with Redux
- Centralized state management for efficient global state access and updates.
-
🔍 Data Fetching with React Query
- Optimized data fetching, caching, and synchronization.
-
🧭 Navigation
- Smooth and intuitive navigation using
react-navigation
with base components likeVStack
andHStack
.
- Smooth and intuitive navigation using
-
⚛️ Component-Based Architecture
- Modular design with reusable UI components and consistent styling.
-
📦 Common Utilities
- Helper functions and utilities for streamlined development.
-
🔗 Axios Management
- Configurable API requests using Axios with built-in error handling and response management.
-
🌐 WebSocket Management
- Real-time communication support using WebSockets.
-
🍪 Cookie Management
- Simplified management of cookies for authentication and user sessions.
-
🔒 Authentication
- User authentication and registration with secure token management.
The project includes a set of reusable components for building user interfaces:
-
Button Components
button.tsx
: Standard button component with customizable styling.
-
Typography Components
h1.tsx
,h2.tsx
: Heading components for consistent typography.text.tsx
: Customizable text component for displaying content.
-
Input Components
input.tsx
: Basic input field component.input-with-icon.tsx
: Input field with an icon for enhanced user interaction.
-
Layout Components
vstack.tsx
: Vertical stack layout for arranging elements vertically.hstack.tsx
: Horizontal stack layout for arranging elements horizontally.spacer.tsx
: Spacer component for adding flexible space between elements.
-
Navigation Components
navbar.tsx
: Customizable navigation bar for app header.
-
Image Components
image.tsx
: Image component for displaying images with caching support.
-
Utility Components
separator.tsx
: Divider component for separating content.separator-with-text.tsx
: Divider with text for enhanced UI.switch.tsx
: Toggle switch component for boolean inputs.
-
Index File
index.ts
: Central export file for components.
Ensure you have the following installed:
- Node.js (v14 or higher)
- Yarn
- Android Studio / Xcode for Android/iOS development
-
Clone the repository:
git clone git@github.com:ToniDarodda/react-native-template.git cd ReactNativeTemplate
-
Install dependencies:
yarn install
-
Configure environment variables:
Update the
.env
file in the root directory with your configuration settings:API_URL='https://your-api-url.com' SOCKET_URL='https://your-socket-url.com'
-
Start the Metro Bundler:
yarn start
-
Run the application on Android:
yarn android
-
Run the application on iOS:
yarn ios
-
Access the application:
The app will be available on your emulator or device.
To run the tests, use the following command:
yarn test
- 🧹 Format code using Prettier:
yarn format
- 🏃♂️ Start the application:
yarn start
- 👨💻 Start in development mode:
yarn android
oryarn ios
- 🔍 Lint the code using ESLint:
yarn lint
- 🧪 Run the tests:
yarn test
- 🚀 Run end-to-end tests:
yarn test:e2e
There is no license; you're free to use it.
- 🚀 Deployment
- ⚙️ Configuration
- 📄 Documentation
- 🔧 Maintenance
- 🔒 Security
- 📫 Email Integration
- 📈 Performance Optimization
- ⚡ Gain Time
Feel free to contribute to this project by submitting issues or pull requests.
For any questions or support, please contact Toni Da Rodda.