An overview of the features and all the stuff included in this boilerplate.
- Clear file structure that favours convention over configuration
- Dark mode support out of the box with styled-components
- Firebase & Firebase Authentication included out of the box
- i18n included for localization
- Vector Icons included using react-native-vector-icons
- MobX with MobX State Tree for state management
- Write your MST models using ES6 classes and decorators with mst-decorators
- React navigation included by default (latest version 5.0)
- react-native-dotenv for handling
.env
files
- Linting support with ESLint out of the box (Airbnb config)
- Automatic code formatting with Prettier
- Automatically remove un-used imports on save
- Automatically sort imports on save
- Commitlint to keep your git commit messages clean
- Model aliases to allow absolute imports relative to src directory e.g.
import {Container} from '@components'
- Pre commit lint-staged hook (thanks to Husky)
- Easily link custom fonts by adding them to
src/assets/fonts
and runningyarn link:fonts
- Functional component generator. Generates component file, story, props and styled file.
- View (screen) generator with test files
- React navigation navigator generator (currently supports
stack
tab
ordrawer
) - MST Model generator
- Service generator
- Repository generator
- Global application styles/themes
- Test environment setup by default. No extra work needed.
- E2E testing included out of the box with Detox
- Component testing with jest and react-test-renderer out of the box
- Visually test components using storybook out of the box
- Automatic test file generation for views, models, repositories, services