ignite README

The project's README from github.com/infinitered/ignite. As one markdown file: README.md.

Ignite README Splash Image

Ignite - the battle-tested React Native boilerplate

npm version GitHub Repo stars Twitter Follow CircleCI

Proven React Native boilerplate

Developed and maintained consistently since 2016, Ignite is the oldest active and most popular third-party React Native / Expo app boilerplate.

This is the React Native starting point that the Infinite Red team uses on a day-to-day basis to build client apps. Developers who use Ignite report that it saves them two to four weeks of time on average off the beginning of their React Native project!

Intro Videos

Here are a few videos / talks that introduce Ignite and show off some of its features. Check them out!

Getting Started with Ignite
Getting Started with Ignite 		Sweetening React Native Development With Ignite
Ignite talk at Chain React 2024 - Robin Heinze

Full Documentation

We've put great effort into the documentation as a team, please read through it here. If you're unsure why a certain decision was made related to this boilerplate or how to proceed with a particular feature, it's likely documented. If it still isn't clear, go through the proper help channels and we always welcome PRs to improve the docs!

Tech Stack

Nothing makes it into Ignite unless it's been proven on projects that Infinite Red works on. Ignite apps include the following rock-solid technical decisions out of the box:

Library Category Version Description
React Native Mobile Framework v0.81 The best cross-platform mobile framework
React UI Framework v19 The most popular UI framework in the world
TypeScript Language v5 Static typechecking
React Navigation Navigation v7 Performant and consistent navigation framework
Expo SDK v55 Allows (optional) Expo modules
Expo Font Custom Fonts v14 Import custom fonts
Expo Localization Internationalization v17 i18n support (including RTL!)
RN Reanimated Animations v4 Beautiful and performant animations
MMKV Persistence v3 State persistence
apisauce REST client v3 Communicate with back-end
Jest Test Runner v29 Standard test runner for JS apps
date-fns Date library v4 Excellent date library
react-native-keyboard-controller Keyboard library v1 Great keyboard manager library
react-native-edge-to-edge UI library v1 Enables edge-to-edge in Android
Reactotron RN Inspector/Debugger v5 JS debugging
Maestro Testing Framework Automate end-to-end UI testing
Hermes JS engine Fine-tuned JS engine for RN

Ignite also comes with a component library that is tuned for custom designs, theming support, testing, custom fonts, generators, and much, much more.

Quick Start

Prerequisites:

The Ignite CLI will walk you through the steps to ignite a new React Native app:

# Get walked through the prompts for the different options to start your new app
npx ignite-cli@latest new PizzaApp

# Accept all the recommended defaults and get straight to coding!
npx ignite-cli@latest new PizzaApp --yes

Once you're up and running, check out our Getting Started Guide.

If you'd like to follow a tutorial, check out this one from Robin Heinze.

Troubleshooting

The above commands may fail with various errors, depending on your operating system and dependency versions. Some troubleshooting steps to follow:

Reporting Bugs / Getting Help

If you run into problems, first search the issues and discussions in this repository. If you don't find anything, you can come talk to our friendly and active developers in the Infinite Red Community Slack (community.infinite.red).

If you still need help after reaching out to the proper channels, feel free to open a new GitHub issue via npx ignite-cli issue "Unable to Ignite new app" (as an example). This will help start writing your issue with the correct diagnostic information included.

Contributing to Ignite

Want to contribute to Ignite? Check out the contributing guide for more info on how to work with the codebase.

Need Inspiration?

If you need battle-tested solutions from Infinite Red experts on everything from Accessibility, to CI/CD configuration, head to Ignite Cookbook for code snippets from our team and the community!

No time to learn React Native? Hire Infinite Red for your next project

We get it – sometimes there just isn’t enough time on a project to learn the ins and outs of a new framework. Infinite Red’s here to help! Our experienced team of React Native engineers have worked with companies like Microsoft, GasBuddy, Zoom, and Mercari to bring some of the most complex React Native projects to life.

Whether it’s running a full project or training a team on React Native, we can help you solve your company’s toughest engineering challenges – and make it a great experience at the same time.

Ready to see how we can work together? Send us a message

Further Reading

License and Trademark Notice

This project's source code is licensed under the MIT License. The Ignite name, its logo, and any other brand assets associated with Ignite and Infinite Red are the exclusive property of Infinite Red, Inc. These marks are not covered by the MIT License provided herein and may not be used without explicit written permission from Infinite Red, Inc.

Note on Generated Code

The MIT License applies solely to the source code of the Ignite CLI and the source code of the included boilerplate project. Any source code generated by using the Ignite CLI, not including trademark assets described above, is owned entirely by the individual or entity that generated it.

However, some files may be added or installed automatically as part of the generation process (e.g. through npm packages). These files are subject to their own licenses, which may include more restrictive terms. It is your responsibility to review and comply with the licenses of any third-party dependencies included in the generated project.

ignite (infinitered/ignite)

expo
Searching Database…

19.9K ·GitHub
Ignite
What is this?Ignite is Infinite Red's React Native project boilerplate, bundled with a CLI and generators for components and models. It has been actively developed since 2016 and is used by the Infinite Red team on real client projects.
Is this a library I import, or a project generator?It is a CLI tool that scaffolds a brand-new React Native/Expo app for you, pre-wired with a curated set of libraries, not something you add to an existing codebase.
How do I create a new project with it?Run the Ignite CLI (typically via npx ignite-cli) which walks you through generating a new app; afterward follow the Getting Started Guide for next steps.
What do I need installed before running the CLI?You need a recent version of Node (the package requires Node 20+), and for building/running on a simulator you need the standard React Native toolchain (Xcode on macOS for iOS, etc.).
Does the install always go smoothly?No — the generation step can fail depending on your OS and dependency versions, with common culprits being outdated Node, missing Xcode command line tools, or a misconfigured Xcode path.
Does it generate apps for both iOS and Android?Yes, it generates a cross-platform React Native/Expo app that targets both iOS and Android, with Expo as an optional SDK layer.
What's actually included in the tech stack out of the box?React Native, React 19, TypeScript, React Navigation 7, Expo SDK 55, Reanimated 4, MMKV for persistence, apisauce for REST, Jest for testing, Maestro for E2E testing, and the Hermes JS engine, among others.
What does 'mst' in the project topics refer to?It refers to MobX-State Tree, the state management approach historically associated with Ignite's generated apps (listed among the project topics).
Why would I use this instead of plain `npx react-native init` or Expo's default template?Ignite bundles years of Infinite Red's battle-tested library choices, navigation setup, theming, testing, and generators, saving reportedly two to four weeks of initial project setup time compared to starting from a bare template.
What are similar projects?awesome-react-native, ng-native, expo, react-native-elements, morphlet, TypeScript-React-Starter, Detox, boardgame.io
Which topics is it in?generator, jest, expo, boilerplate, state-management, react-native, mobile-app, testing, ios, android, framework, react
Creator
infinitered
Size
60.4 MB
Stars
19.9K
Updated
CommitApr 30Releasev11.5.0Mar 18
Age
10y
Commits · 90 Days