Description

This repository is a React Native application. It contains the source code for a mobile app which reads commits from GitHub this Repository

Dependencies

• node.js >=12 (recommended installation method: nvm)
• yarn >=1.12
• React Native (63.0.x): Installing react native and running it on mobile emulators requires additional steps. Follow the instructions in the React Native Getting Started Guide to setup the app to run on both iOS (requiring macOS and XCode) and Android using Android Studio.

Installation

yarn install

Recommended WorkFlow & Debugging for Developers

• React Native works best if you can run a simulator on the same computer and enable live reloading on the simulator.
• iOS is typically easier to work with.
• React native also has a Debugger, which is useful to know about when making changes. (On android devices, the debugger can be triggered using a command: yarn android:debug.)

Run the App on the iOS Simulator

yarn ios

Run the App on the Android Simulator

yarn android

Run on a real device

See Running On Device. This is generally clunkier for development but is important for seeing the app the same way users do and it tends to run smoother than on an emulator.

Separation of Concerns

assets/ # static assets like images, logos, fonts, etc
components/ # React UI components
containers/ # React containers which pass data and logic into components
sagas/ # Redux middleware library
helpers/ # reusable modules and business logic
navigation/ # Navigation logic
reducers/ # Redux reducers
App.js // entrypoint for the application
app.json // configuration for the application

Core libraries & Docs

The following libraries are extensively used:

• react-native
• react: UI components
• redux, react-redux
• prop-types: validations for UI component inputs