rain

A Clojure/Script library for fast and flexible web apps.

When you start architecting a new web app, one of the foundational decisions you make is - "How and where do I want to render content?". Should it be rendered on the web server, build server, on the Edge, or directly on the client? Should it be rendered all at once, partially, or progressively? (patterns.dev)

Rain helps you answer these questions. Once you decide on an approach, you can use rain new to create an app from scratch and deploy it to a JAMstack host or cloud VPS provider in minutes. Check out the Installation and Usage sections to get started.

Supports multiple rendering patterns in the same app:
- Static Site Generation (SSG)
- Incremental Static Generation (ISG)
- Server-Side Rendering (SSR)
- Client-Side Rendering (CSR)
- Hydration
Supports reusable code between the server and browser
Helpers for biff, reitit, reagent, and re-frame
Fast
Extensible

Status: alpha

Installation
Docs
Usage
Additional Resources

Installation

Command-Line Tool (CLI)

First, install bbin. Then run the following command:

bbin install io.github.rads/rain

Now you can run rain in your shell to see the docs for the CLI tool.

Library

Add io.github.rads/rain to your deps.edn:

io.github.rads/rain {:git/tag "v0.1.8" :git/sha "c490345"}

See the Usage section for examples on how to use the library to build an app.

Docs

API Docs

Usage

Rain supports multiple rendering patterns. See the table below to find an example based on your needs.

Note: This table is a work-in-progress and may change as Rain matures. For a more nuanced view of rendering patterns, see the Additional Resources section.

<table> <thead> <tr> <td></td> <td>SSG</td> <td>ISG</td> <td>CSR</td> <td>SSR</td> <td>Hydration</td> </tr> </thead> <tbody> <tr> <td>Example</td> <td><a href="http://github.com/rads/rain.examples.ssg">rain.examples.ssg</a></td> <td><a href="http://github.com/rads/bbin-site">bbin-site</a></td> <td><a href="#">TODO</a></td> <td><a href="#">TODO</a></td> <td><a href="http://github.com/rads/rain.examples.todomvc">rain.examples.todomvc</a></td> </tr> <tr> <td>Command</td> <td><code>rain new -t ssg</code></td> <td>TODO</td> <td>TODO</td> <td>TODO</td> <td><code>rain new -t hydration</code></td> </tr> <tr> <td>Use Cases</td> <td>Landing pages, blogs</td> <td>Dashboards</td> <td>Full-featured apps</td> <td>Document-based sites</td> <td>Supports both CSR and SSR use cases</td> </tr> <tr> <td>Host as a static site (JAMstack)?</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> <td>No</td> <td>No</td> </tr> <tr> <td>API required?</td> <td>No</td> <td>No</td> <td>Yes</td> <td>No</td> <td>Yes</td> </tr> <tr> <td>Custom server required?</td> <td>No</td> <td>No</td> <td>No</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>JavaScript required for viewing?</td> <td>No</td> <td>No</td> <td>Yes</td> <td>No</td> <td>No</td> </tr> <tr> <td>JavaScript required for interaction?</td> <td>No</td> <td>No</td> <td>Yes</td> <td>No</td> <td>Yes</td> </tr> <tr> <td>Dynamic content on build?</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>Dynamic content after deploy?</td> <td>No</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>Dynamic content based on request?</td> <td>No</td> <td>No</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>User login supported?</td> <td>No</td> <td>No</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>First Content Paint (FCP)?</td> <td>Good</td> <td>Good</td> <td>Varies</td> <td>Good</td> <td>Good</td> </tr> <tr> <td>Time-to-Interactive (TTI)?</td> <td>Good</td> <td>Good</td> <td>Varies</td> <td>Good</td> <td>Varies</td> </tr> </tbody> </table>

Rain

Install / Use

README