https://github.com/trixtateam/react-native-boiler-plate

A React Native project template for building solid applications keeping the state, selectors, sagas together with a screen.
https://github.com/trixtateam/react-native-boiler-plate

generated-code nodejs phoenix-channels react react-hook-form react-hooks react-native react-native-paper react-navigation redux redux-saga

Last synced: 3 months ago
JSON representation

A React Native project template for building solid applications keeping the state, selectors, sagas together with a screen.

• Host: GitHub
• URL: https://github.com/trixtateam/react-native-boiler-plate
• Owner: trixtateam
• License: mit
• Created: 2020-04-22T09:43:00.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T19:27:52.000Z (over 3 years ago)
• Last Synced: 2025-03-14T12:34:46.852Z (over 1 year ago)
• Topics: generated-code, nodejs, phoenix-channels, react, react-hook-form, react-hooks, react-native, react-native-paper, react-navigation, redux, redux-saga
• Language: JavaScript
• Homepage:
• Size: 3.92 MB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          





![GitHub Release Date](https://img.shields.io/github/release-date/trixtateam/react-native-boiler-plate?style=for-the-badge)

![GitHub last commit](https://img.shields.io/github/last-commit/trixtateam/react-native-boiler-plate?style=for-the-badge)

![GitHub commit activity](https://img.shields.io/github/commit-activity/m/trixtateam/react-native-boiler-plate?style=for-the-badge)

![GitHub commits since latest release](https://img.shields.io/github/commits-since/trixtateam/react-native-boiler-plate/latest?style=for-the-badge)

![GitHub top language](https://img.shields.io/github/languages/top/trixtateam/react-native-boiler-plate?style=for-the-badge)

Start your next react native project in seconds









  Inspired by Max Stoiber's React Boiler Plate.








  Created by Jacques Nel.

  


  Integrating React Native with Phoenix Channels



## Features



  
Quick scaffolding

  
Create components, containers, navigators, selectors and sagas - and their tests - right from the CLI!


  
Instant feedback

  
Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes to the styles and JS are reflected instantaneously without refreshing the app. Preserve application state even when you update something in the underlying code!


  
Predictable state management

  
Unidirectional data flow allows for change logging and time travel debugging.


  
Next generation JavaScript

  
Use template strings, object destructuring, arrow functions, JSX syntax and more.

  

  
Redux Integration

    
Use template strings, object destructuring, arrow functions, JSX syntax and more.

    

  
Redux Saga Integration

  
Executing logic in an asynchronous way without ending in callback hell.

   Sagas are triggered by Redux actions and can also trigger Redux actions to alter state. By using JavaScript generators (`yield`), sagas are written in a synchronous-like manner while still executing asynchronously.

  



## Quick start

1.  Make sure that you have Node.js v8.10 and npm v5 or above installed.

2.  Follow the [getting started guide](https://reactnative.dev/docs/environment-setup)

3.  Clone this repo using `git clone --depth=1 https://github.com/trixtateam/react-native-boiler-plate.git `

4.  Move to the appropriate directory: `cd `.


5.  Run `npm run install` in order to install dependencies and clean the git repo.


### Android

- only the first time you run the project, you need to generate a debug key with:

  - `cd android/app`

  - `keytool -genkey -v -keystore debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000`

  - `cd ../..` to come back to the root folder

- `npm run start` to start the metro bundler, in a dedicated terminal

- `npm run android` to run the Android application (remember to start a simulator or connect an Android phone)

### iOS

- `cd ios`

- `pod install` to install pod dependencies

- `cd ..` to come back to the root folder

- `npm run start` to start the metro bundler, in a dedicated terminal

- `npm run ios` to run the iOS application (remember to start a simulator or connect an iPhone phone)

Now you're ready to rumble!

## Documentation

- [**The Hitchhikers Guide to `react-native-boiler-plate`**](docs/general/introduction.md): An introduction for newcomers to this boilerplate.

- [Overview](docs/general): A short overview of the included tools

- [**Commands**](docs/general/commands.md): Getting the most out of this boilerplate

- [Testing](docs/testing): How to work with the built-in test harness

- [Your app](docs/js): Supercharging your app with Navigation, Redux, simple

  asynchronicity helpers, etc.

- [**Troubleshooting**](docs/general/gotchas.md): Solutions to common problems faced by developers.

## Supporters



## License

This project is licensed under the MIT license, Copyright (c) 2019  Jacques

Nel. For more information see `LICENSE.md`.