Boilerplate for React Native.
npm install ignite-boilerplate-kosCurrently includes:
* React Native 0.57.7 (but you can change this if you want to experiment)
* React Navigation
* Redux
* Redux Sagas
* Eslint rules
* Flow
* Screens/components generator
When you've installed the Ignite CLI, you can get started with this boilerplate like this:
``
ignite new App -b ignite-boilerplate-kos
Your App folder is where most of the goodies are found in an Ignite Next app. Let's walk through them in more detail. Start with Containers/App.js (described below) and work your way down the walkthrough in order.
Containers are (mostly) full screens, although they can be sections of screens or application containers.
* App.js - your main application. We create a Redux store and configure it hereRootContainer.js
* - main view of your application. Contains your status bar and navigation componentLaunchScreen.js
* - this is the first screen shown in your application. It's loaded into the Navigation componentStyles
* - styling for each of the above containers and screens
To generate a new Container or Screen you can use the following generator commands:
* ignite g screen New - Will create a NewScreen.js and also a Styles/NewScreenStyle.js. Important to mention that the screen generator will add the Screen on the file/class name to make easier to identify.
Those commands will also add the new container to the navigations file.
Your primary and other navigation components reside here.
* AppNavigation.js - loads in your initial screen and creates your menu(s) in a StackNavigationStyles
* - styling for the navigationReduxNavigation.js
* - This file contains the core navigation of your application. If you ever change your launch screen, make sure to change it also at if (nav.routes.length === 1 && (nav.routes[0].routeName === 'LaunchScreen')) {, otherwise you may encounter navigation problems with the Android back button!
React components go here...pretty self-explanatory. We won't go through each in detail -- open each file to read the comments and view the code.
To generate a new Component you can use the following generator commands:
* ignite g component New - Will create a New.js and also a Styles/NewStyle.js.ignite g component path/New
* - The same as above, but will use a relative pathignite g component --folder path
* - An alternative to ignite g component path/index
* - An alternative to ignite g component relativePath/New
Styling themes used throughout your app styles.
* ApplicationStyles.js - app-wide stylesColors.js
* - defined colors for your appFonts.js
* - defined fonts for your appImages.js
* - loads and caches images used in your appMetrics.js
* - useful measurements of things like navBarHeight
Initialize and configure things here.
* AppConfig.js - simple React Native configuration hereDebugConfig.js
* - define how you want your debug environment to actReactotronConfig.js
* - configures Reactotron in your project (Note: this will be extracted into a plugin in the future)ReduxPersist.js
* - configures Redux Persist (Note: this will be extracted into a plugin in the future)
Contains json files that mimic API responses for quicker development. These are used by the Services/FixtureApi.js object to mock API responses.
Contains a preconfigured Redux and Redux-Sagas setup. Review each file carefully to see how Redux interacts with your application.
Here again we have generators to help you out. You just have to use one of the following:
* ignite g redux Amazing - Will generate and link the redux for Amazing.ignite g saga Amazing
* - The same as above, but for the Sagas
Contains your API service and other important utilities for your application.
* Api.js - main API service, giving you an interface to communicate with your back endExamplesRegistry.js
* - lets you view component and Ignite plugin examples in your appFixtureApi.js
* - mocks your API service, making it faster to develop early on in your appImmutablePersistenceTransform.js
* - part of the redux-persist implementation (will be removed)RehydrationServices.js
* - part of the redux-persist implementation (will be removed)
We recommend using this folder for modules that can be extracted into their own NPM packages at some point.
Contains actual images (usually png) used in your application.
Helpers for transforming data between API and your application and vice versa. An example is provided that you can look at to see how it works.
This folder (located as a sibling to App) contains sample Jest snapshot and unit tests for your application.
If you would like to have the ignite generate command include the generation of tests when available, add "test": "jest" or "test": "ava" to ./ignite/ignite.json`, depending on the test runner you are using.