Ignite CLI

🔥 The hottest CLI for React Native: boilerplates, plugins, generators, and more. 🔥

Why Ignite CLI?

Easily spin up a new React Native app with best practices built-in
No runtime! This is a developer tool only, not a library you have to depend on and figure out how to upgrade
An ever-expanding list of boilerplates and plugins to jump-start your app
An amazing community of other Ignite / React Native developers when you need help
Battle tested and used every day by the developers at Infinite Red and thousands of developers around the world
Works on macOS, Windows, and Linux because not all React Native developers are on one platform

And you also get (by default) all of the sweet, sweet goodness of our default boilerplate, Bowser, or choose one of many others.

⬇️ Install

First, make sure you're set up for React Native

then...

Make sure you have a reasonably recent version of Node (7.6+ minimum). You can check your version of node by running

node -v

then...

Install Yarn for your system.

finally...

$ yarn global add ignite-cli
$ ignite new MyNewAppName

Quick Example

Infinite Red provides two primary boilerplates; they are:

Andross - the tried and true (React Navigation, Redux, & Redux Saga)
Bowser - the latest and greatest (React Navigation, MobX State Tree, & TypeScript)

Use Ignite Bowser: Infinite Red Bowser boilerplate

$ yarn global add ignite-cli
$ ignite new PizzaApp
  ( Choose `Bowser` when prompted )
$ cd PizzaApp
$ ignite generate screen pizza-location-list
  ( Choose `example` domain when prompted. This determines where your new screen will go in the directory structure. )
$ ignite generate component pizza-location
  ( Choose `example` domain when prompted. This determines where your new screen will go in the directory structure. )
$ ignite --help

Use Ignite Andross Infinite Red Andross boilerplate

$ yarn global add ignite-cli
$ ignite new PizzaApp
  ( Choose Andross when prompted )
$ cd PizzaApp
$ ignite add maps
$ ignite add vector-icons
$ ignite generate screen PizzaLocationList
$ ignite generate component PizzaLocation
$ ignite generate map StoreLocator
$ ignite add i18n
$ ignite remove i18n
$ ignite --help

📋 Documentation 📋

Want to dive into the Ignite CLI documentation? Go here
Looking for React Native's documentation? Go here.

🔌 Plugins 🔌

Check out the list of Plugins.

🍽️ Boilerplates 🍽️

Check out the list of Boilerplates.

$ ignite new MyNewAppName -b ir-boilerplate

💩 Troubleshooting 💩

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

🔭 Where to Go From Here 🔭

Contribute to Ignite CLI - Getting up and running for your first pull request

Take a tour of Ignite CLI source code

Get inspired by apps built with Ignite

Chat with us on the IR Community - Infinite Red devs standing by

Who are We? - Learn More About Infinite Red

Project Web Page - Ignite on Infinite Red

Check out Gluegun - Ignite CLI is powered by Gluegun, which lets you build CLI apps painlessly!

❤️ Special Thanks ❤️

Thank you to the numerous contributors of Ignite CLI. Our awe and appreciation for the friendliness of Open Source is the fuel for all Infinite Red projects like Ignite CLI.

Premium Support

Ignite CLI, as open source projects, is free to use and always will be. To help support providing Ignite CLI and boilerplates for free, Infinite Red offers premium React Native app design/development services. Get in touch here or email us at hello@infinite.red.

cristin/ignite