https://github.com/jntn/now-shadow-cljs

A now builder for ClojureScript projects using shadow-cljs
https://github.com/jntn/now-shadow-cljs

builder clojure clojurescript now zeit

Last synced: 17 days ago
JSON representation

A now builder for ClojureScript projects using shadow-cljs

• Host: GitHub
• URL: https://github.com/jntn/now-shadow-cljs
• Owner: jntn
• License: mit
• Created: 2019-03-01T11:41:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-05-27T22:19:07.000Z (over 2 years ago)
• Last Synced: 2024-09-20T03:18:08.198Z (about 2 months ago)
• Topics: builder, clojure, clojurescript, now, zeit
• Language: JavaScript
• Size: 751 KB
• Stars: 21
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# now-shadow-cljs

A ▲ Vercel Now 2.0 builder for ClojureScript projects using shadow-clj. The builder will build your shadow-cljs targets and deploy them to ▲ Vercel Now.

## Usage

1. Create a shadow-cljs project. This builder supports building `:browser` and `:node-library` targets. If the target is `:browser` it will be deployed as a static page and if it is `:node-library` it will be deployed as a lambda function.

2. Create a `now.json` file that uses `@jntn/now-shadow-cljs` using version 2 (This builder does not currently work with the latest version 3). **Note:** If you do not specify a `routes` section, the build output will be available under the specified output folder. For `:node-library` it is the `:output-to` path and for `:browser` it is the `:output-dir` path.

For an example using both browser and node builds, see [github.com/jntn/haiku](https://github.com/jntn/haiku)

### Example `now.json`

``` json

{

    "version": 2,

    "name": "haiku",

    "builds": [

        {

            "src": "shadow-cljs.edn",

            "use": "@jntn/now-shadow-cljs"

        }

    ],

    "routes": [

        {

            "src": "/(.*)",

            "dest": "/public/$1"

        },

        {

            "src": "/api/(.*)",

            "dest": "/api/$1"

        }

    ]

}

```

### Example `shadow-cljs.edn`

``` clojure

{:builds {:haikus {:target :node-library

                   ;; Will be available at "/api/haikus"

                   :output-to "api/haikus/index.js"

                   :exports-var jntn.api.haikus/handler}

          :app {:target :browser

                ;; Will by default be available at "/public" but

                ;; using the now.json above it is reached at "/"

                :output-dir "public/js"

                :asset-path "js"

                :modules {:main {:entries [jntn.app.core]}}

                :devtools {:http-root "public"

                           :proxy-url "http://localhost:3000"

                           :http-port 8000}}}}

```

## Caveats

* Right now the only supported build targets are `:browser` and `:node-library`.

* The builder does not currently work with `:deps true` in `shadow-cljs.edn`.