|
1 year ago | |
---|---|---|
android | 5 years ago | |
ios | 4 years ago | |
src | 4 years ago | |
.editorconfig | 5 years ago | |
.eslintrc.js | 4 years ago | |
.flowconfig | 5 years ago | |
.gitignore | 5 years ago | |
.snyk | 4 years ago | |
.travis.yml | 5 years ago | |
.watchmanconfig | 5 years ago | |
Dockerfile | 2 years ago | |
LICENSE | 5 years ago | |
README.md | 1 year ago | |
cover.jpg | 2 years ago | |
package.json | 4 years ago | |
webpack.config.js | 4 years ago |
No Longer Maintained
This kit was originally used to build and ship, and later extracted from, Lumpen Radio early in the RN lifecycle. Since then there have been significant advances in RN tooling and, as a result, I recommend checking out some of the other Awesome React Native Boilerplates that've popped up lately. Have fun out there!
Build your React Native app with Webpack and Babel.
Simple asset pipeline for seed apps built with React Native. Uses Babel 6 for ES7 JavaScript transpilation with Stage 1 support, and Webpack as a dev server and module bundler. Provides static code linting using ESLint and build output in the same console window, and Source Maps for debugging in the browser. Unprescriptive in terms of test frameworks and Flux implementations. Additional features listed below.
webpack-notifier
for desktop notifications on OS XClone repo and install dependencies once your environment is set-up:
git clone -o upstream -b master --single-branch \
https://github.com/jhabdas/react-native-webpack-starter-kit.git native-starter-kit && cd $_ && npm i
Once project cloned and dependencies installed, run it with:
npm start
This will start the React Packager and a Webpack Dev Server. The dev server will watch your JS files for changes, automatically linting your code as you iterate. Additionally, the dev server will generate the index.[platform].js
files expected by your React Native iOS or Android app, allowing you the freedom to build
Status: All systems go.
Open ios/App.xcodeproj
in Xcode, build and run the project.
Unlike the app currently generated by react-native init
this app removes the UIViewControllerBasedStatusBarAppearance
key to prevent an App Store rejection I received submitting Lumpen Radio to the App Store. The key may be added back, if desired.
For information on HMR support for iOS see react-native-webpack-server/issues/103.
Status: Bug in simulator. Test on actual device instead.
For android development use the following:
npm run android-setup-port # Note that this option is available on devices running android 5.0+ (API 21)
react-native run-android
If you run into any issues please see the Getting Started guide for React Native before submitting an issue.
Status: Experimental.
This kit includes a Dockerfile
which can be used to create a virtualized development environment for building your app. To use it on Windows set-up Docker Machine then run the commands below with cmder (or similar) to get going. OS X users are encouraged to use dlite instead of Docker Machine for this setup.
.watchmanconfig
to the following: {"ignore_dirs": ["node_modules"]}
.docker build --rm .
command from the project root directory to build a virtualized Linunx environment configured for development using this starter kit.docker images
and looking for the most recently created image.docker run -it 09608e4ec865 /bin/bash
(where 09608e4ec865
is the Image ID) and run the app with npm start
.If iOS and Android device emulators are not available for your development environment (anything except OS X, basically) consider shipping code directly to a native device using Exponent or CodePush.
As a minimalist seed this project does not introduce a testing framework. Instead it leverages simple static code analysis to help prevent coding mistakes and introduce some patterns for building React Native apps with ES2015 and ES7 with a functional mindset inspired by the Elm architecture and functional React alternatives like Deku.
Webpack is configured with a pre-loader to lint the application with ESLint using the Babel parser during app development. And the npm lint
command may be run at anytime to lint source code otherwise. See the .eslintrc
file to adjust linter rules to your liking. Or run npm test
to lint the application and scan its dependencies it for known security vulnerabilities.
To bundle the app for distribution for both iOS and Android:
npm run bundle
to generate the offline JS bundle.AppDelegate.m
to load from pre-bundled file on disk.Please see Submitting to App Store for instructions on iOS. If you have any good Android instructions, please send a PR this way. Good luck and have fun out there!