Skip to content

README.md

Latest commit

 

History

History
74 lines (52 loc) · 1.89 KB

README.md

File metadata and controls

74 lines (52 loc) · 1.89 KB

Krell Project Generator

Scaffold a Krell (ClojureScript + React Native) project using Babashka.

Prerequisites

Quick Start

Replace AwesomeProject with your project name (CamelCase):

curl -s https://raw.githubusercontent.com/ampersanda/krell-template-runner/master/krell.sh | bash -s AwesomeProject

Options

-p, --package PACKAGE_NAME   Organization package name (e.g. com.example.krell)
-v, --version VERSION        React Native version (e.g. 0.72.0)
-h, --help                   Show help

Example with options:

curl -s https://raw.githubusercontent.com/ampersanda/krell-template-runner/master/krell.sh | bash -s AwesomeProject --package com.example.krell

What It Does

  1. Creates a React Native project via @react-native-community/cli
  2. Installs Node dependencies
  3. Adds Krell and Reagent ClojureScript dependencies (deps.edn, build.edn)
  4. Installs Clojure dependencies
  5. Runs pod install for iOS (if CocoaPods is available)
  6. Generates a starter ClojureScript namespace with a Reagent component

After Setup

cd AwesomeProject
clj -m krell.main -co build.edn -c -r

In separate terminal tabs:

npx react-native start
# iOS
npx react-native run-ios

# Android
npx react-native run-android

Production build:

clj -m krell.main -v -co build.edn -O advanced -c

Documentation