A command line tool for developing React Native apps
---
[![Build Status][build-badge]][build]
[![Version][version-badge]][package]
[![MIT License][license-badge]][license]
[![All Contributors][all-contributors-badge]](#contributors)
[![PRs Welcome][prs-welcome-badge]][prs-welcome]
[![Code of Conduct][coc-badge]][coc]
[![Chat][chat-badge]][chat]
[![tweet][tweet-badge]][tweet]
Haul is a drop-in replacement for `react-native` CLI built on open tools like Webpack. It can act as a development server or bundle your React Native app for production.
## Features
- Replaces React Native packager to bundle your app
- Access to full webpack ecosystem, using additonal loaders and plugins is simple
- Doesn't need watchman, symlinks work nicely
- Helpful and easy to understand error messages
- Hot Module Reloading
## Getting started
Start by adding Haul as a dependency to your React Native project (use `react-native init MyProject` to create one if you don't have a project):
```bash
yarn add --dev haul
```
If you're on a React Native version >= 0.43, add the following in `android/app/build.gradle` somewhere before the `apply from: "../../node_modules/react-native/react.gradle"` statement:
```
project.ext.react = [
cliPath: "node_modules/haul/bin/cli.js"
]
```
To configure your project to use haul, run the following:
```bash
yarn haul init
```
This will automatically add the configuration needed to make Haul work with your app, e.g. add `webpack.haul.js` to your project, which you can customise to add more functionality.
Next, you're ready to start the development server:
```bash
yarn haul start -- --platform ios
```
Finally, reload your app to update the bundle or run your app just like you normally would:
```bash
react-native run-ios
```
## Documentation
Check out the docs to learn more about available commands and tips on customizing the webpack configuration.
1. [CLI Commands](docs/CLI%20Commands.md)
1. [Configuration](docs/Configuration.md)
1. [Recipes](docs/Recipes.md)
### Hot Module Replacement
Please refer to the [Setup guide](./docs/hmr/Setup.md).
## Limitations
Haul uses a completely different architecture from React Native packager, which means there are some things which don't work quite the same.
We are actively working on adding support for the following:
- Existing `react-native` commands
The following features are **unlikely to be supported** in the future:
- Haste module system: use something like [babel-plugin-module-resolver](https://github.com/tleunen/babel-plugin-module-resolver) instead
- Transpile files under `node_modules`: transpile your modules before publishing, or configure webpack not to ignore them
# Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
| [
Mike Grabowski](https://twitter.com/grabbou)
[π¬](#question-grabbou "Answering Questions") [π»](https://github.com/grabbou/haul/commits?author=grabbou "Code") [π¨](#design-grabbou "Design") [π](https://github.com/grabbou/haul/commits?author=grabbou "Documentation") [π‘](#example-grabbou "Examples") [π€](#ideas-grabbou "Ideas, Planning, & Feedback") [π](#review-grabbou "Reviewed Pull Requests") | [
Satyajit Sahoo](https://twitter.com/satya164)
[π¬](#question-satya164 "Answering Questions") [π»](https://github.com/grabbou/haul/commits?author=satya164 "Code") [π¨](#design-satya164 "Design") [π€](#ideas-satya164 "Ideas, Planning, & Feedback") [π](#review-satya164 "Reviewed Pull Requests") | [
PaweΕ TrysΕa](https://twitter.com/_zamotany)
[π¬](#question-zamotany "Answering Questions") [π](https://github.com/grabbou/haul/issues?q=author%3Azamotany "Bug reports") [π»](https://github.com/grabbou/haul/commits?author=zamotany "Code") [π](https://github.com/grabbou/haul/commits?author=zamotany "Documentation") [π‘](#example-zamotany "Examples") [π€](#ideas-zamotany "Ideas, Planning, & Feedback") | [
Krzysztof Borowy](https://twitter.com/Krizzu)
[π¬](#question-Krizzu "Answering Questions") [π](https://github.com/grabbou/haul/issues?q=author%3AKrizzu "Bug reports") [π»](https://github.com/grabbou/haul/commits?author=Krizzu "Code") [π€](#ideas-Krizzu "Ideas, Planning, & Feedback") | [
MichaΕ PierzchaΕa](https://twitter.com/thymikee)
[π»](https://github.com/grabbou/haul/commits?author=thymikee "Code") [π€](#ideas-thymikee "Ideas, Planning, & Feedback") [β οΈ](https://github.com/grabbou/haul/commits?author=thymikee "Tests") | [
Steve Kellock](https://github.com/skellock)
[π»](https://github.com/grabbou/haul/commits?author=skellock "Code") | [
Mathieu Dutour](https://mathieu.dutour.me)
[π»](https://github.com/grabbou/haul/commits?author=mathieudutour "Code") |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| [
Orta](http://orta.io)
[π](https://github.com/grabbou/haul/commits?author=orta "Documentation") | [
Yann Pringault](https://github.com/Kerumen)
[π»](https://github.com/grabbou/haul/commits?author=Kerumen "Code") [π](https://github.com/grabbou/haul/commits?author=Kerumen "Documentation") | [
Drapich Piotr](https://github.com/dratwas)
[π»](https://github.com/grabbou/haul/commits?author=dratwas "Code") [π](https://github.com/grabbou/haul/commits?author=dratwas "Documentation") | [
JΓΊlio CΓ©sar](http://julioc.me)
[π](https://github.com/grabbou/haul/issues?q=author%3AJulioC "Bug reports") [π»](https://github.com/grabbou/haul/commits?author=JulioC "Code") | [
LiJung Chi](http://chilijung.me)
[π»](https://github.com/grabbou/haul/commits?author=chilijung "Code") | [
spypsy](https://github.com/spypsy)
[π»](https://github.com/grabbou/haul/commits?author=spypsy "Code") | [
Juwan Wheatley](https://fiber-god.github.io/)
[π](https://github.com/grabbou/haul/commits?author=fiber-god "Documentation") |
| [
Jeremi Stadler](http://jeremi.se)
[π](https://github.com/grabbou/haul/commits?author=jeremistadler "Documentation") | [
David Sheldrick](https://github.com/ds300)
[π»](https://github.com/grabbou/haul/commits?author=ds300 "Code") | [
Miguel Oller](https://twitter.com/ollermi)
[π](https://github.com/grabbou/haul/issues?q=author%3Amigueloller "Bug reports") [π»](https://github.com/grabbou/haul/commits?author=migueloller "Code") | [
Krzysztof Karol](https://github.com/KrzysztofKarol)
[π»](https://github.com/grabbou/haul/commits?author=KrzysztofKarol "Code") | [
Jakub Stasiak](https://github.com/jakubsta)
[π»](https://github.com/grabbou/haul/commits?author=jakubsta "Code") | [
Ferran Negre](http://twitter.com/ferrannp)
[π](https://github.com/grabbou/haul/issues?q=author%3Aferrannp "Bug reports") [π»](https://github.com/grabbou/haul/commits?author=ferrannp "Code") | [
CL123123](https://github.com/CL123123)
[π](https://github.com/grabbou/haul/commits?author=CL123123 "Documentation") |
| [
Marty Penner](http://penner.me)
[π](https://github.com/grabbou/haul/commits?author=martypenner "Documentation") | [
Jim Cummins](https://jimthedev.com)
[π](https://github.com/grabbou/haul/commits?author=jimthedev "Documentation") | [
Gant Laborde](https://github.com/GantMan)
[π](https://github.com/grabbou/haul/commits?author=GantMan "Documentation") | [
PaweΕ Burniak](https://github.com/mitcom)
[π](https://github.com/grabbou/haul/commits?author=mitcom "Documentation") | [
bsnelder](https://github.com/bsnelder)
[π»](https://github.com/grabbou/haul/commits?author=bsnelder "Code") | [
aivæn](https://ivan.moe/)
[π»](https://github.com/grabbou/haul/commits?author=SEAPUNK "Code") | [
Nemanja Stojanovic](https://nem035.com)
[π»](https://github.com/grabbou/haul/commits?author=nem035 "Code") |
| [
bogdanbolchis](https://github.com/bogdanbolchis)
[π](https://github.com/grabbou/haul/commits?author=bogdanbolchis "Documentation") | [
Joe Arasin](http://joe.arasin.com)
[π](https://github.com/grabbou/haul/issues?q=author%3Ajoearasin "Bug reports") [π»](https://github.com/grabbou/haul/commits?author=joearasin "Code") | [
Norbert de Langen](https://github.com/ndelangen)
[π](https://github.com/grabbou/haul/commits?author=ndelangen "Documentation") | [
Gustav Wengel](http://gustavwengel.dk)
[π](https://github.com/grabbou/haul/commits?author=GeeWee "Documentation") | [
Eric Wooley](http://ericwooley.github.io)
[π](https://github.com/grabbou/haul/issues?q=author%3Aericwooley "Bug reports") [π»](https://github.com/grabbou/haul/commits?author=ericwooley "Code") | [
Matt Cubitt](https://github.com/mattcubitt)
[π](https://github.com/grabbou/haul/issues?q=author%3Amattcubitt "Bug reports") [π»](https://github.com/grabbou/haul/commits?author=mattcubitt "Code") | [
Jakub BeneΕ‘](https://jukben.cz)
[π»](https://github.com/grabbou/haul/commits?author=jukben "Code") |
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
[build-badge]: https://img.shields.io/circleci/project/github/callstack/haul/master.svg?style=flat-square
[build]: https://circleci.com/gh/callstack/haul
[version-badge]: https://img.shields.io/npm/v/haul.svg?style=flat-square
[package]: https://www.npmjs.com/package/haul
[license-badge]: https://img.shields.io/npm/l/haul.svg?style=flat-square
[license]: https://github.com/callstack/haul/blob/master/LICENSE
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs-welcome]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/callstack/haul/blob/master/CODE_OF_CONDUCT.md
[all-contributors-badge]: https://img.shields.io/badge/all_contributors-34-orange.svg?style=flat-square
[chat-badge]: https://img.shields.io/badge/chat-slack-brightgreen.svg?style=flat-square&colorB=E01563
[chat]: https://slack.callstack.io/
[tweet-badge]: https://img.shields.io/badge/tweet-%23haul-blue.svg?style=flat-square&colorB=1DA1F2&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAUCAYAAACXtf2DAAAAAXNSR0IArs4c6QAAAaRJREFUOBGtlM8rBGEYx3cWtRHJRaKcuMtBSitxkCQ3LtzkP9iUUu5ODspRHLhRLtq0FxeicEBC2cOivcge%2FMgan3fNM8bbzL4zm6c%2BPT%2Fe7%2FO8887svrFYBWbbtgWzsAt3sAcpqJFxxF1QV8oJFqFPFst5dLWQAT87oTgPB7DtziFRT1EA4yZolsFkhwjGYFRO8Op0KD8HVe7unoB6PRTBZG8IctAmG1xrHcfkQ2B55sfI%2ByGMXSBqV71xZ8CWdxBxN6ThFuECDEAL%2Bc9HIzDYumVZ966GZnX0SzCZvEqTbkaGywkyFE6hKAsBPhFQ18uPUqh2ggJ%2BUor%2F4M%2F%2FzOC8g6YzR1i%2F8g4vvSI%2ByD7FFNjexQrjHd8%2BnjABI3AU4Wl16TuF1qANGll81jsi5qu%2Bw6XIsCn4ijhU5FmCJpkV6BGNw410hfSf6JKBQ%2FUFxHGYBnWnmOwDwYQ%2BwzdHqO75HtiAMJfaC7ph32FSRJCENUhDHsLaJkL%2FX4wMF4%2BwA5bgAcrZE4sr0Cu9Jq9fxyrvBHWbNkMD5CEHWTjjT2m6r5D92jfmbbKJEWuMMAAAAABJRU5ErkJggg%3D%3D
[tweet]: https://twitter.com/intent/tweet?text=Check%20out%20Haul!%20https://github.com/callstack/haul%20%F0%9F%91%8D