taranvitalii / rn-boilerplate

RnBoilerplate

A React Native boilerplate project to kickstart your development with pre-configured settings.

Table of Contents

• RnBoilerplate
  • Table of Contents
  • Introduction
  • Features
  • Requirements
  • Installation
  • Scripts
  • Dependencies
  • Project Structure
  • Contributing
  • License

Introduction

RnBoilerplate is a starting point for building React Native applications with a modern setup. It includes a set of pre-configured tools and libraries to streamline your development workflow.

Features

• React Navigation for easy navigation management.
• TypeScript for type safety.
• ESLint and Prettier for code linting and formatting.
• Jest for testing.
• Husky and pretty-quick for pre-commit hooks.

Requirements

• Node.js >= 18

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/RnBoilerplate.git
   cd RnBoilerplate

2. Install the dependencies:

   npm install

3. Install the necessary iOS dependencies:

   npx pod-install ios

Scripts

• android: Runs the Android app.
• ios: Runs the iOS app.
• lint: Runs ESLint for linting the code.
• start: Starts the React Native packager.
• type: Builds the TypeScript files.
• test: Runs the Jest test suite.
• prepare: Prepares Husky hooks.

You can run these scripts using npm run <script>.

Dependencies

• @react-navigation/native: ^6.1.18
• @react-navigation/native-stack: ^6.10.1
• react: 18.2.0
• react-native: 0.74.1
• react-native-safe-area-context: ^4.10.8
• react-native-screens: ^3.32.0

Project Structure

RnBoilerplate/
├── app/
│   ├── modules/
│   │   └── home/
│   │       └── screens/
│   │           └── HomeScreen.tsx
│   ├── AppContent.tsx
│   └── ...
├── node_modules/
├── .eslintrc.js
├── .prettierrc
├── tsconfig.json
├── package.json
└── ...