🔥reactnative-steroids-boilerplate🔥
Operating systems supported >= Android 4.4 (API 19)
Step 1: git clone https://github.com/Liftitapp/react-native-liftit-boilerplate.git <YourProjectName>
Step 2: cd <YourProjectName> && npm install
cd <YourProjectName>- Create a
.envfile with the following variables:
APP_VERSION_CODE /*Version code of your Android app ie. 0.0.1*/
APP_VERSION_NAME /*Version name of your Android app ie. v0.1-beta*/
GITHUB_API_URL=https://api.github.com/
- Run Build for Android (iOS following soon)
- for Android
- Run your preffer Android emulator or connect your phone with the Debugging Mode enabled
npm run start- On another console:
react-native run-android
- for Android
| Feature | Summary |
|---|---|
| Ignite | The project was generated with this tool |
| DotEnv | Environment variables for Javascript files. - + info |
| ReactNativeConfig | Environment vars for React components and Android (*.xml, *.gradle, *.java) files. - + info |
| ESLint | Linter used on the project. - + info |
| i18n | Support to i18n. - + info |
| Jest | Testing (with coverage). - + info |
| Codacy | Code review an analytics. - + info |
| Storybook | Testing for React-Native UI components. - + info |
| Flow | Type checker for Javascript (with flowcheck). - + info |
| Sentry | Realtime error tracking. - + info |
| NewRelic | App monitoring. - + info |
| Reactotron | Debug tool for React Native apps. - + info |
| Redux | A predictable state container - Helping you write applications that behave consistently and run in different environments. |
| Redux-saga | Is a library that aims to make side effects (i.e. asynchronous things like data fetching and impure things like accessing the browser cache) in React/Redux applications easier and better. |
| Apisauce | Great form to communicate with APIs. |
| Gulp | Toolkit for automating painful or time-consuming tasks in your development workflow, so you can stop messing around and build something. |
This module reads .env files from the root folder, stores their variables in a process.env object.
require('dotenv').config()
console.log(process.env.APP_VERSION_CODE)
Use this way to access to the enviroment variables from outside the react-native application (eg. On the tests folder, or on the gulp file)
This module is used to expose configuration variables to your javascript code inside the react-native application.
Android
- Java files - Through the BuildConfig object.
public HttpURLConnection getApiClient() {
URL url = new URL(BuildConfig.API_URL);
// ...
}
- Gradle configuration files - Through the project.env.get() function.
defaultConfig {
applicationId project.env.get("APP_ID")
}
- XML configuration files (eg.
AndroidManifest.xml)- Through the @string annotation.
<meta-data
android:name="com.google.android.geo.API_KEY"
android:value="@string/GOOGLE_MAPS_API_KEY" />
Linter used to check syntax errors on the code, it uses a config file called .eslintrc stored on the root folder.
The .eslintignore (also stored on the root folder) is used to ignore specific folders or files, like a .gitignore file
Run on the console: npm run superlint
Internationalization for the project. The languages are stored on app/i18n/languages, on .json files, and must be exported on app/i18n/index.js
import I18n from 'app/i18n'
{ I18n.t('greetings') }
This project uses Jest for unit testing. All tests live on the tests folder
Run on the console: npm run test
It creates a Coverage folder, which tell you the percentage of your code which is tested and is used to report it to Codacy
Codacy check code style, security, duplication, complexity and quality on every commit. You must integrate it with your repository.
Coverage - To send to Codacy the coverage info created by Jest, there are a Gulp script (gulpfile.js) that use the "PROJECT_TOKEN" of your Codacy project. This "PROJECT_TOKEN" must be setted on your .env file like CODACY_SECRET_TOKEN
Run on the console: npm run gulp
(Coverage folder must exist)
With this, you can test all your UI components on realtime.
- Run your preffer Android emulator or connect your phone with the Debugging Mode enabled
- Run on the console:
npm run storybook - Visit
localhost:7007on your browser
It check the typed of all your Javascript code, and uses a config file called .flowconfig stored on the root folder.
You must indicate which files want to be checked with the @flow annotation on top of your files.
Run on the console: npm run flow
If you use VSCode editor, it's recommended install "Flow Language Support" extension.
This project is configurated to report all its errors on production to be tracked by Sentry.
On your .env file, must exist this vars, according to your Sentry project information:
SENTRY_DSN
SENTRY_URL
SENTRY_ORG
SENTRY_PROJECT
On app/config/index.js:18 is enabled the use of this system.
This project is configurated to be monitored by New Relic.
Add the following NewRelic variable on the .env file:
NEWRELIC_ANDROID_TOKEN
Enable app/config/index.js:19 to be used in the system.
The functionality of this app can be inspectioned by Reactotron.
- Install Reactotron
- Open the Reactotron app
- Run your preffer Android emulator or connect your phone with the Debugging Mode enabled
- Run on the console:
npm run reactotron:server
This project uses react-native-config to expose config variables to your code in React Native app, and dotenv to expose them outside the React Native app. You must store API keys and other sensitive information in a .env file, on the root folder.
The minimum variables required by this project are:
APP_VERSION_CODE /*Version code of your Android app eg. 0.0.1*/
APP_VERSION_NAME /*Version name of your Android app eg. v0.1-beta*/
GITHUB_API_URL=https://api.github.com/
The .env file is ignored by git keeping those secrets out of your repository.
Made with ❤️ by Liftit - Developed by David Quinto
- Improve the README.md of Sagas, Redux, Storybooks and Screens.
- Change README's system to GitHub Wiki.
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
MIT ©
Copyright 2017 Liftit
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.