Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prestancedesign/inertia-clojure
A Clojure adapter for Inertia.js
https://github.com/prestancedesign/inertia-clojure
clojure compojure inertia-clojure inertiajs inertiajs-adapter middleware react reagent reitit ring
Last synced: 23 days ago
JSON representation
A Clojure adapter for Inertia.js
- Host: GitHub
- URL: https://github.com/prestancedesign/inertia-clojure
- Owner: prestancedesign
- License: epl-1.0
- Created: 2021-04-19T16:41:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-30T07:08:45.000Z (over 2 years ago)
- Last Synced: 2024-12-17T06:58:21.279Z (25 days ago)
- Topics: clojure, compojure, inertia-clojure, inertiajs, inertiajs-adapter, middleware, react, reagent, reitit, ring
- Language: Clojure
- Homepage: https://inertia.prestance-design.com/
- Size: 79.1 KB
- Stars: 97
- Watchers: 5
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-inertiajs - Clojure
README
# Inertia Clojure
Clojure Middleware adapter for [Inertia.js](https://inertiajs.com/) to build single-page apps, without building an API.
The latest versions on Clojars
[](https://clojars.org/com.github.prestancedesign/inertia-clojure)
## Introduction
Inertia is a new approach to building classic server-driven web apps. From their own web page:
> Inertia allows you to create fully client-side rendered, single-page apps, without much of the complexity that comes with modern SPAs. It does this by leveraging existing server-side frameworks.
Inertia requires an adapter for each backend framework.
For Clojure there is no de facto web framework, so I went with a [Ring](https://github.com/ring-clojure/ring) middleware who shape up the [`request`](https://github.com/ring-clojure/ring/wiki/Concepts#requests) and [`response`](https://github.com/ring-clojure/ring/wiki/Concepts#responses) to meet the Inertia.js [protocol](https://inertiajs.com/the-protocol).
## Install
For `deps.edn`:
```clojure
com.github.prestancedesign/inertia-clojure {:mvn/version "0.2.5"}
```
For `project.clj`:
```clojure
[com.github.prestancedesign/inertia-clojure "0.2.5"]
```
## Usage
Inertia-clojure contains a standard Ring middleware `wrap-inertia` that you can use with routing libraries like [Reitit](https://github.com/metosin/reitit), [Compojure](https://github.com/weavejester/compojure), etc.
The middleware must be the last item in your web middleware chain.
It expects 3 arguments:
* the app handler
* template: a function that recieves data-page arg - a correctly encoded string of the Inertia page object. The function should return an HTML string, so the template lib is up to you.
* version: your current asset version https://inertiajs.com/asset-versioning
Note: In your HTML template function make sure to always include the `data-page` string in the attribute of the HTML node you want to render your JavaScript app in.
For more information on how Inertia works read the protocol on the Inertia website https://inertiajs.com/the-protocol.
## Example
```clojure
(require '[inertia.middleware :as inertia])
;; ... Another required lib (compojure, httpkit, etc)
(def asset-version "1")
;; Create html template with library of your choice, here Hiccup
(defn template [data-page]
(page/html5
[:head
[:meta {:charset "utf-8"}]
[:title "Inertia + Clojure example"]]
[:body
[:div {:id "app"
:data-page data-page}] ; The Inertia JSON page object
(page/include-js "/js/app.js")])) ; Include your Reagent, React, Vue or Svelte SPA
(defroutes routes
(GET "/" [] (inertia/render :index {:title "Hello World!"})) ; Use the Inertia render helper to return formatted response
(GET "/demo" [] (inertia/render :demo {:title "Clojure + Inertia"}))
(route/resources "/"))
(def app (inertia/wrap-inertia routes template asset-version)) ; Wrap your handler with the Inertia middleware
(http/run-server app {:port 3000})
```
## Project examples
### Full stack
* [Ping CRM](https://github.com/prestancedesign/clojure-inertia-pingcrm-demo): port of the official Inertia demo to Clojure Ring, Reitit, Integrant and next.jdbc
* [Usermanager Integrant + Reitit stack](https://github.com/prestancedesign/reagent-inertia-reitit-integrant-fullstack): Single page application in Clojure Ring, Reitit + Reagent/Inertia.js
* [Usermanager Component + Compojure stack](https://github.com/prestancedesign/usermanager-reagent-inertia-example): Single Page App demo in Clojure, Ring, Compojure + Reagent/Inertia.js
* [Inert - Inertia + Clojure + Svelte](https://git.sr.ht/~korven/svelte-inertia): Single Page App demo in Clojure, Reitit-Ring, Svelte/Inertia.js and Vite. You can check out the live website here - [Inert](https://inert-clj.herokuapp.com).
### Server side
* [Reitit / Selmer](examples/server-side/reitit-selmer): An example with Reitit routing and Selmer template lib
* [Compojure / Hiccup](examples/server-side/compojure-hiccup): An example with Compojure routing and Hiccup for the template
### Client side
* [Reagent / Shadow-CLJS + Inertia.js](examples/client-side/reagent-inertiajs)
## Features
Features of the official server-side adapters are still in progress.
### Todo:
- [x] Shared data
- [x] Partial reloads
- [X] Assets versionning
- [x] Validation error props
- [ ] Lazy loaded props
- [ ] Root template data
## License
Copyright © 2021 Michaël Salihi / Prestance
Distributed under the Eclipse Public License version 1.0.