Natal

Bootstrap ClojureScript-based React Native apps

Dan Motzenbecker, MIT License @dcmotz

Natal is a simple command-line utility that automates most of the process of setting up a React Native app running on ClojureScript.

It stands firmly on the shoulders of giants, specifically those of Mike Fikes who created Ambly and the documentation on setting up a ClojureScript React Native app.

Usage

Before getting started, make sure you have the required dependencies installed.

Then, install the CLI using npm:

$ npm install -g natal

To bootstrap a new app, run natal init with your app's name as an argument:

$ natal init FutureApp

If your app's name is more than a single word, be sure to type it in CamelCase. A corresponding hyphenated Clojure namespace will be created.

By default Natal will create a simple skeleton based on the current stable version of Om (aka Om Now). If you'd like to base your app upon Om Next, you can specify a React interface template during init:

$ natal init FutureApp --interface om-next

Keep in mind your app isn't limited to the React interfaces Natal provides templates for; these are just for convenience.

If all goes well your app should compile and boot in the simulator.

From there you can begin an interactive workflow by starting the REPL.

$ cd future-app
$ rlwrap natal repl

(If you don't have rlwrap installed, you can simply run natal repl, but using rlwrap allows the use of arrow keys).

If there are no issues, the REPL should connect to the simulator automatically. To manually choose which device it connects to, you can run rlwrap natal repl --choose.

At the prompt, try loading your app's namespace:

(in-ns 'future-app.core)

Changes you make via the REPL or by changing your .cljs files should appear live in the simulator.

Try this command as an example:

(swap! app-state assoc :text "Hello Native World")

When the REPL connects to the simulator it will begin to automatically log success messages, warnings, and errors whenever you update your .cljs files.

Tips

• Having rlwrap installed is optional but highly recommended since it makes the REPL a much nicer experience with arrow keys.

• Don't press ⌘-R in the simulator; code changes should be reflected automatically. See this issue in Ambly for details.

• Running multiple React Native apps at once can cause problems with the React Packager so try to avoid doing so.

• You can launch your app on the simulator without opening Xcode by running natal launch in your app's root directory.

• By default new Natal projects will launch on the iPhone 6 simulator. To change which device natal launch uses, you can run natal listdevices to see a list of available simulators, then select one by running natal setdevice with the index of the device on the list.

• To change advanced settings run natal xcode to quickly open the Xcode project.

• The Xcode-free workflow is for convenience. If you're encountering app crashes, you should open the Xcode project and run it from there to view errors.

• You can run any command with --verbose or -v to see output that may be helpful in diagnosing errors.

Dependencies

As Natal is the orchestration of many individual tools, there are quite a few dependencies. If you've previously done React Native or Clojure development, you should hopefully have most installed already. Platform dependencies are listed under their respective tools.

• npm >=1.4
  • Node.js >=4.0.0
• Leiningen >=2.5.3
  • Java 8
• CocoaPods >=0.38.2
  • Ruby >=2.0.0
• Xcode (+ Command Line Tools) >=6.3
  • OS X >=10.10
• Watchman >=3.7.0
• rlwrap >=0.42 (optional but recommended for REPL use)
• react-native-cli >=0.1.7 (install with npm install -g react-native-cli)

Updating Natal

You can get the latest version of Natal by running npm install -g natal again.

Aspirations

• [x] Xcode-free workflow with CLI tools
• [x] Templates for other ClojureScript React wrappers
• [x] Automatic wrapping of all React Native component functions for ClojureScript
• [x] Automatically tail compilation log and report errors to REPL
• [ ] Automatically run React packager in background
• [ ] Working dev tools
• [ ] Automatic bundling for offline device usage and App Store distribution
• [ ] Android support
• [ ] Automatic setup of JS modules

Example apps bootstrapped with Natal

• Om Next app with Python server by David Mohl, demonstrated in a talk at the Tokyo iOS Meetup.

• Zooborns by Jearvon Dharrie, demonstrated in a talk at Clojure/conj 2015.

Coda

Contributions are welcome.

For more ClojureScript React Native resources visit cljsrn.org.

If you're looking for a simple ClojureScript wrapper around the React Native API, check out the companion library Natal Shell. It is included by default in projects generated by Natal.