๐ฅ The ideal starting app for React Native, best practices, generators, and more. ๐ฅ
- No Need to Fork! Command-line Generator
- Apps
- Components/Styles
- Containers (smart components)
- Screens (opinionated containers)
- and more...
- JS Code Standard - Standard Compliant
- ALL CODE works with iOS and Android
- Documented Structure
- Battle Tested - We use this!
- Redux State Management
- Optional Redux Persistence (uses AsyncStorage via redux-persist)
- Redux Sagas
- Githooks
- AVA Tests - even React Native components!
- Code Coverage Reports
- API Ready
- Reactotron Ready
- Included Common Libs:
- Included Developer Libs:
To view the generated example project, just pull down the code and run ignite-base!
Make sure you're set up for React Native
Step 1: Install
npm install -g react-native-ignite
or
yarn global add react-native-ignite
NOTE: If you seem to not have ignite
available on your path, check that your correct yarn bin directory is on your path by checking that the output of yarn global bin
is listed as a directory in $PATH
environment variable.
For those of you unfamiliar with the new package manager Yarn, it's basically a 1 for 1 replacement for npm, but with a significant speed boost. Check out this yarn cheatsheet for more info.
Step 2: Use
ignite new MyApplication
- cd to the repo
- Run Build for either OS
- for iOS
- run the command
react-native run-ios
- run the command
- for Android
- Run Genymotion
- run the command
react-native run-android
- If the packager does not automatically start, run
npm start
oryarn start
- Enjoy!
These are some common issues you may run into while setting up Ignite. If you encounter something that is not listed here, try searching for the issue in GitHub.
Android
-
Problem:
After running
react-native android
you get the following error:com.android.ide.common.process.ProcessException: org.gradle.process.internal.ExecException: Process 'command ' /usr/lib/jvm/java-8-oracle/bin/java'' finished with non-zero exit value 2
Solution:
(cd android && ./gradlew clean)
- The application generator uses the
ignite-base
template to provide a fresh application with all the common tech wired up and ready to roll. Base applications come with common development screens, tools, and components. As for now, this is a 'Kitchen Sink' plan of attack. Eventually to be pared down, and adjustable in v2.0
- The component generator creates a new 'dumb component' with the stylesheet. Both files are created and placed in their appropriate folders.
- A generated container is a smart component that is connected to Redux. Usually for containing other components. The component and stylesheet are placed in the
Containers
folder.
- A generated screen is an opinionated container with a generated route. Keyboard avoiding and other base code is placed in this connected smart component.
- React Native listview container with easy step-by-step instructions on how to get started with an easy list template.
- Generate a reducer with three actions and three types:
request
,success
andfailure
, all hooked together into a reducer.
- Generate a saga - the generated example handles connecting to a third party api. Designed for use in tandem with redux generator.
- react-native-maps container, component, and map helpers with easy step-by-step instructions on how to get started with an simple map screen.
- Imports all files in
Images
folder and converts the names into key: value pairs in the image object inside of theImages.js
file in theThemes
folder.
- ignite-base aka [BASE] - is the generated default app. Some files are different and have a
.template
extension. - ignite-cli aka [CLI] - is the app that wraps our yeoman generators, and other commands. This is the
react-native-ignite
node module. - ignite-generator aka [GEN] - Yeoman generators for Ignite. This is the
generator-react-native-ignite
node module that the CLI depends on for generating app items. - fireDrill.sh - A shell script for verifying the necessary relationship between folders and files is in good shape. Since versions, templates, and linting is enforce, we have it all in one friendly script for developers and CI.
- testRelease.sh - A shell script that automatically ignites a project based on the repo to make sure it generates correctly, and functions to the best of automated testability. This script is run before every release.
Ignite is tested on every release: See release history for changes and upgrades.
Ignite master
branch is tested against facebook's react-native master
branch every 24 hours. Though this doesn't immediately affect the current release of Ignite, it helps us detect early issues with upgrading: Current status ![Build Status](https://camo.githubusercontent.com/b3cfa8f79377ee61ea4e592353cfbfccf9a7a395f471648bf3261c6ea8b8d57a/68747470733a2f2f7472617669732d63692e6f72672f696e66696e6974657265642f69676e6974652e7376673f6272616e63683d6d6173746572)
Contribute to Ignite - Getting up and running for your first pull request
Chat with us on Gitter - Infinite Red devs standing by
Chosen Tech Docs - Understand the Tech Inside
Roadmap Wiki Page - Future Plans of Ignite
Who are We? - Learn More About Infinite Red
Project Web Page - Our Github Page
Thank you to the numerous contributors of Ignite. Additionally, our Gitter/Slack integration has been most graciously donated by SameRoom.io. Our awe and appreciation for the friendliness of Open Source is the fuel for all Infinite Red projects like Ignite.