|
| 1 | +--- |
| 2 | +sidebar_position: 1 |
| 3 | +--- |
| 4 | + |
1 | 5 | # Welcome to Ignite documentation! |
2 | 6 |
|
3 | | -Check out this list of topics: |
4 | | - |
5 | | -- [Getting Started Guide](./Guide.md) - If you're new to Ignite, start here |
6 | | -- [Components](./Components.md) - Ignite's built-in UI components |
7 | | - - [AutoImage](./Components-AutoImage.md) |
8 | | - - [Button](./Components-Button.md) |
9 | | - - [Card](./Components-Card.md) |
10 | | - - [EmptyState](./Components-EmptyState.md) |
11 | | - - [Header](./Components-Header.md) |
12 | | - - [Icon](./Components-Icon.md) |
13 | | - - [ListItem](./Components-ListItem.md) |
14 | | - - [ListView](./Components-ListView.md) |
15 | | - - [Screen](./Components-Screen.md) |
16 | | - - [Text](./Components-Text.md) |
17 | | - - [TextField](./Components-TextField.md) |
18 | | -- [Utils](./Utils.md) - Collection of helpful utilities |
19 | | - - [useSafeAreaInsetsStyle](./Utils-useSafeAreaInsetsStyle.md) |
20 | | - - [useHeader](./Utils-useHeader.md) |
21 | | -- [Theming](./Theming.md) - How to customize the look and feel of your app |
22 | | - - [Colors & Palettes](./Theming-Colors-And-Palettes.md) - Explanation of our palette-based approach to colors |
23 | | - - [Fonts & Typography](./Theming-Fonts-And-Typography.md) - How we define fonts in a semantic way |
24 | | - - [Spacing](./Theming-Spacing.md) - How to approach consistent spacing throughout your Ignite app |
25 | | -- [Styling](./Styling.md) - How we approach styling components in Ignite |
26 | | -- [Navigation](./Navigation.md) - How [React Navigation](https://reactnavigation.org/docs/getting-started/) is used to navigate through your screens |
27 | | -- [Testing](./Testing.md) - How to test your Ignite app |
28 | | -- [Generators](./Generators.md) - Everything you need to know about Ignite generators |
29 | | - - [Generator Templates](./Generator-Templates.md) - Writing your own generator templates |
30 | | -- [Folder-Structure](./Folder-Structure.md) - An explanation of the Ignite folder structure |
31 | | -- [Why MobX-State-Tree?](./MobX-State-Tree.md) - All about MobX-State-Tree, and why we use it instead of Redux |
32 | | -- [Expo and Ignite](./Expo-and-Ignite.md) - How Expo fits in with Ignite, and whether you should use it |
33 | | -- [TypeScript](./TypeScript.md) - An explanation of TypeScript in Ignite and lots of resources |
34 | | -- [Upgrading Ignite](./Upgrading-Ignite.md) - How to upgrade your app to the latest and greatest Ignite patterns |
35 | | -- [Tour of Ignite](./Tour-of-Ignite.md) - Tour of the Ignite code base for interested contributors |
36 | | -- [Releasing Ignite](./Releasing-Ignite.md) - How we release Ignite |
37 | | -- [Internationalization](./Internationalization.md) — How to Internationalize your app |
38 | | -- [Backend API Integration](./Backend-API-Integration.md) - An explanation of Ignite's basic API setup |
39 | | -- [Remove Demo Code](./Remove-Demo-Code.md) - A quick guide on how to remove Ignite's demo code via command line |
| 7 | +## Getting Started |
| 8 | + |
| 9 | +### Quick Start |
| 10 | + |
| 11 | +```terminal |
| 12 | +npx ignite-cli@latest new pizza-app --yes |
| 13 | +``` |
| 14 | + |
| 15 | +### Full Guide |
| 16 | + |
| 17 | +If you're new to Ignite, start by reading our [Getting Started Guide](./Guide.md)! |
| 18 | + |
| 19 | +### Intro Video |
| 20 | + |
| 21 | +Check out the [Getting Started with Ignite](https://www.youtube.com/watch?v=KOSvDlFyg20) video for a 13 minute overview! |
| 22 | + |
| 23 | +## Proven React Native boilerplate |
| 24 | + |
| 25 | +The culmination of over seven years of constant React Native development, Ignite is the most popular React Native app boilerplate for both Expo and bare React Native. |
| 26 | + |
| 27 | +This is the React Native boilerplate that the [Infinite Red](https://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! |
| 28 | + |
| 29 | +## Usage |
| 30 | + |
| 31 | +- [Command-line Interface (CLI)](./cli/Ignite-CLI.md) |
| 32 | + - [Remove Demo Code](./cli/Remove-Demo-Code.md) - A quick guide on how to remove Ignite's demo code via command line |
| 33 | + - [Troubleshooting](./cli/Troubleshooting.md) |
| 34 | +- [Components](./boilerplate/components/Components.md) - Ignite's built-in UI components |
| 35 | + - [AutoImage](./boilerplate/components/AutoImage.md) |
| 36 | + - [Button](./boilerplate/components/Button.md) |
| 37 | + - [Card](./boilerplate/components/Card.md) |
| 38 | + - [EmptyState](./boilerplate/components/EmptyState.md) |
| 39 | + - [Header](./boilerplate/components/Header.md) |
| 40 | + - [Icon](./boilerplate/components/Icon.md) |
| 41 | + - [ListItem](./boilerplate/components/ListItem.md) |
| 42 | + - [ListView](./boilerplate/components/ListView.md) |
| 43 | + - [Screen](./boilerplate/components/Screen.md) |
| 44 | + - [Text](./boilerplate/components/Text.md) |
| 45 | + - [TextField](./boilerplate/components/TextField.md) |
| 46 | +- [Concepts](./concept/Concepts.md) - An overview of the concepts behind developing with Ignite |
| 47 | + |
| 48 | + - [Backend API Integration](./concept/Backend-API-Integration.md) - An explanation of Ignite's basic API setup |
| 49 | + - [Expo and Ignite](./concept/Expo-and-Ignite.md) - How Expo fits in with Ignite, and whether you should use it |
| 50 | + - [Folder-Structure](./concept/Folder-Structure.md) - An explanation of the Ignite folder structure |
| 51 | + - [Generators](./concept/Generators.md) - Everything you need to know about Ignite generators |
| 52 | + - [Generator Templates](./concept/Generator-Templates.md) - Writing your own generator templates |
| 53 | + - [Internationalization](./concept/Internationalization.md) — How to Internationalize your app |
| 54 | + - [Why MobX-State-Tree?](./concept/MobX-State-Tree.md) - All about MobX-State-Tree, and why we use it instead of Redux |
| 55 | + - [Navigation](./concept/Navigation.md) - How [React Navigation](https://reactnavigation.org/docs/getting-started/) is used to navigate through your screens |
| 56 | + - [Styling](./concept/Styling.md) - How we approach styling components in Ignite |
| 57 | + - [Testing](./concept/Testing.md) - How to test your Ignite app |
| 58 | + - [TypeScript](./concept/TypeScript.md) - An explanation of TypeScript in Ignite and lots of resources |
| 59 | + - [Upgrades](./concept/Upgrades.md) - How to upgrade your app to the latest and greatest Ignite patterns |
| 60 | + |
| 61 | +- [Theming](./boilerplate/theming/Theming.md) - How to customize the look and feel of your app |
| 62 | + - [Colors & Palettes](./boilerplate/theming/Colors-And-Palettes.md) - Explanation of our palette-based approach to colors |
| 63 | + - [Fonts & Typography](./boilerplate/theming/Fonts-And-Typography.md) - How we define fonts in a semantic way |
| 64 | + - [Spacing](./boilerplate/theming/Spacing.md) - How to approach consistent spacing throughout your Ignite app |
| 65 | +- [Utils](./boilerplate/utility/Utils.md) - Collection of helpful utilities |
| 66 | + - [useSafeAreaInsetsStyle](./boilerplate/utility/useSafeAreaInsetsStyle.md) |
| 67 | + - [useHeader](./boilerplate/utility/useHeader.md) |
| 68 | + |
| 69 | +## Contributing |
| 70 | + |
| 71 | +- [Tour of Ignite](./contributing/Tour-of-Ignite.md) - Tour of the Ignite code base for interested contributors |
| 72 | +- [Releasing Ignite](./contributing/Releasing-Ignite.md) - How we release Ignite |
0 commit comments