Awesome Open Source
Awesome Open Source

Friday App

🚀 Friday App 🚀

Build enterprise React Native apps

React Native Template - TypeScript

Travis Code Climate iOS and Android License PRs Welcome Code Size Releases

An opinionated React Native Starter Kit with React Native Navigation + Redux + Airbnb TSLint to build iOS and Android apps using TypeScript

The project has been setup based off RN Getting Started and instructions from Microsoft's Github TypeScript React Native Starter repo.

React Native Typescript Boilerplate


Supports React 17, React Native 0.66.0, React Native Navigation v7, Flipper and Hermes

Update (Nov 2021):

  • Added Types (actions, reducers, store, components and more).
  • Core API service using fetch
  • Support for M1
Updates RNN RN React Comments
Nov '21 7.23.1 0.66.0 17.0.2 Type definitions
May '21 7.14.0 0.64.1 17.0.1 Update RN RNN, Hermes Support
Oct '20 7.1.0 0.63.3 16.13.1 Support for Flipper
Apr '20 3.7.0 0.61.5 16.9.0 Support for RN > 0.60, Android X
Nov '19 2.26.2 0.59.10 Maintenance
Mar '19 2.13.1 0.58.6 16.8.4

Introduction

Jumpstart building robust apps using React Native and TypeScript with most commoly needed tools already setup. Just yarn install and get going from respective IDEs.

  • Routing and Navigation
  • State Management using Flux Architecture
  • Atomic Design pattern
    • The structure of the app is inspired by atomic design pattern.
    • Widgets / Elements: Build your own Design Language System with these building blocks.
      • Typography: Base Typography setup - Color, Font, LAYOUT, CTA, FONTS, TEXT, TEXT_INPUT
      • elements: <BUTTON_DEFAULT> or <CTEXT>. They are custom elements that have default properties like font, size and so on.
      <CTEXT style={GLOBAL.CTA.Style.primaryText}>{title}</CTEXT>
      
      • widgets: Any component providing a complete functionality. E.g. carousels component, banner component, etc.
      <Category componentId={componentId} title={locale.Categories} />
      
  • Type Definitions
    • Type definitons for actions, reducers, store, components and more.
  • Built-in Splash screen
  • Hermes and Flipper integrations
  • Code Lint
App Screens
Splash Home Side Menu
Flipper Support

Flipper

Table of Contents

Project Structure

/
├── android						Android Native code
├── ios							iOS Native Code
├── shared
│   ├── redux					Applications Logic
│   │   ├── constants
│   │   ├── actions
│   │   ├── api
│   │   ├── reducers
│   │   ├── store
│   │   └── thunk
│   └── utilities
│   ├── services
│   │   ├── core				Core Services - API (fetch/axios), storage
│   │   │  ├── API
│   │   │  └── Storage
│   │   ├── home
│   │   └── search
├── src
│   ├── config					Global Configuration
│   ├── constants				Screen names and ids, Localization
│   ├── navigators				Router, Navigation
│   ├── view					UI compoments
│   │   ├── elements				Custom elements
│   │   ├── assets
│   │   ├── screens
│   │   ├── styles				Typography
│   │   └── widgets				Custom components
│   └── utilities
├── __tests__					Unit Tests
│   ├── presentation
│   └── redux
├── .babelrc
├── .gitignore
├── .travis.yml					Travis CI
├── tsconfig.json				TypeScript Configuration
├── tslint.js					TSLint configuration - extending AirBnb
├── tsconfig.json
├── app.json
├── index.js					Application Entry point
├── package.json
└── README.md

shared Everything related to application business logic. The redux store.

src Presentation layer for the app - screens, styles, images, icons etc.

Getting Started

Make sure node version installed is >=12.x.x. Then install using yarn (or npm):

yarn install

Start the Metro Bundler:

yarn start
iOS

One time. Move to ios folder and install pods:

cd ios && pod install

Launch application from XCode (Command + R) Or launch from Terminal:

yarn ios
# runs the following command. change device name here
# `npx react-native run-ios --simulator='iPhone 11'`
Android

Start an Android Simulator from:

Android Studio > Tools > AVD Manager > Run any device

Similarly, run from Android Studio itself Or from Terminal:

yarn android
# runs the following command
# react-native run-android --variant=Debug

Commands

Remark
yarn start Starts metro bundler
yarn ios Starts iOS app. Start metro bundler first
yarn android Starts Android app. Start metro bundler and Android emulator first
yarn lint linting
yarn lint:fix tries to fix linting issues automatically
yarn build:android:debug Android debug build
yarn build:android:release Android release build

Cheat Sheet

iOS Launch Screen

XCode -> Project Folder -> Click on `Images.xcassets` -> Click on `LaunchScreen`

Change the 3 images here to set the new launch screen for iOS.

Launch Screen

Android Launch Screen

`./android/app/src/main/res/drawable-*` folders

Change the images the drawable-* folders to set the new launch screen for Android.

M1 support

Some additional steps may be required for project to work on M1.

  • Disable Rosetta in Terminal
  • Install ffi
sudo arch -x86_64 gem install ffi
  • Re-install dependencies
arch -x86_64 pod install

Now try and run CocoaPods.

P.S.: Thanks to samanthadotcom#7043 (discord)

Single Screen vs Tabbed Based Navigation

The application launches with a splash screen, and then moves to a tabbed based navigation. Splash screen is a good place to fetch data / build application launch logic like getting user token from API or Async Store, load persist state etc.

For Single screen application, replace this tabbed based navigation with a single screen - just home, or simply use the splash screen to setup the app, may be with a burger menu.

Renaming the App

You might also want to rename the app for your own use. Follow any of the links below.

Or

Contributing

Please check out Contributing.

Authors

See also the list of contributors.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Typescript (264,731) 
Android (41,726) 
Ios (19,630) 
Redux (13,341) 
React Native (11,831) 
Template (8,113) 
Boilerplate (5,611) 
Redux Thunk (1,419) 
Starter Kit (1,395) 
Related Projects
Advertising 📦 9
All Projects
Application Programming Interfaces 📦 120
Applications 📦 181
Artificial Intelligence 📦 72
Blockchain 📦 70
Build Tools 📦 111
Cloud Computing 📦 79
Code Quality 📦 28
Collaboration 📦 30
Command Line Interface 📦 48
Community 📦 81
Companies 📦 60
Compilers 📦 60
Computer Science 📦 74
Configuration Management 📦 39
Content Management 📦 167
Control Flow 📦 197
Data Formats 📦 77
Data Processing 📦 266
Data Storage 📦 132
Economics 📦 60
Frameworks 📦 198
Games 📦 122
Graphics 📦 103
Hardware 📦 148
Integrated Development Environments 📦 47
Learning Resources 📦 147
Legal 📦 28
Libraries 📦 119
Lists Of Projects 📦 21
Machine Learning 📦 336
Mapping 📦 61
Marketing 📦 15
Mathematics 📦 55
Media 📦 228
Messaging 📦 97
Networking 📦 304
Operating Systems 📦 84
Operations 📦 120
Package Managers 📦 52
Programming Languages 📦 229
Runtime Environments 📦 96
Science 📦 42
Security 📦 375
Social Media 📦 26
Software Architecture 📦 70
Software Development 📦 68
Software Performance 📦 57
Software Quality 📦 127
Text Editors 📦 45
Text Processing 📦 131
User Interface 📦 310
User Interface Components 📦 465
Version Control 📦 29
Virtualization 📦 68
Web Browsers 📦 38
Web Servers 📦 25
Web User Interface 📦 194