re-natal/README.md

2.3 KiB

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

First, install the CLI using npm:

$ npm install -g natal

Then run natal with your app's name as the first argument:

$ natal FutureApp

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

When Xcode appears, click the play button to run the app on the simulator.

Then run the following for an interactive workflow:

$ cd future-app
$ ./start.sh

First, choose the correct device (Probably [1]). At the REPL prompt type this:

(in-ns 'future-app.core)

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

Try this command as an example:

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

When the REPL starts it will print the location of its compilation log. It's useful to tail it to see any errors, like so:

$ tail -f /Volumes/Ambly-81C53995/watch.log

Tips

  • Natal requires npm, Leiningen, and CocoaPods to be installed
  • Having rlwrap installed is optional but 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

Aspirations

  • Automatic wrapping of all React Native component functions for ClojureScript
  • Xcode-free development with CLI tools
  • Automatically run React packager in background
  • Automatically tail cljs build log and report compile errors
  • Templates for other ClojureScript React wrappers

Contributions are welcome.