astoddard / cljs-spa-example

A demo Single Page Application written in ClojureScript

Single Page Applications (SPAs) in ClojureScript, while often simple, are not always easy to understand. This example project demonstrates what I think is the best way to build SPAs today.

Usage

Make sure you have yarn and the Clojure CLI tools installed.

At development time, run

scripts/dev

# or to clean all build artifacts

scripts/dev --reset

to start a reloading figwheel server, then open http://localhost:9333/ in your browser.

To build a production build, run

scripts/prod

and open dist/index.html in the browser.

Principles

• Data-driven routing

  Navigation is a concern of the M and C of your MVC application, not of the V, so routing should be decoupled from the view layer of your application.

• Single global state

  A single global state atom is a simple and clear way to manage state. It makes it obvious where state resides. This project uses a single ratom, but to keep things simple it doesn't introduce a state management a la re-frame.

• Explicit resource management

  When the user enters a page, the app needs to perform asynchronous side-effects (often network requests) and acquire resources (set up event listeners, timers, stateful objects). Conversely, resources need to be disposed of when leaving the page. Page resource management should be explicitly tied to navigation events, rather than component lifecycle methods.

• Reloadability

  Hot reloading while keeping state is critical for developer productivity.

• Embrace NPM

  ClojureScript rocks, but JavaScript reaches - and it has a powerful ecosystem. Because CLJS has great JS interop, prefer state-of-the-art NPM libraries over less powerful ClojureScript alternatives. Instead of CLJS-specific CLJSJS jars, directly tap NPM, the delivery path used by thousands of developers.

• Embrace the Web Platform

  Modern JS engines ship with high-quality abstractions like fetch and ES6 promises. Use these over CLJS alternatives.

• Error management

  Use Promise rejections to signal errors.

Technical details

• Figwheel Main

  Use Figwheel Main as the build tool. It's faster, cleaner and actively developed.

• Webpack doublebundle

  To require NPM dependencies (including, but not limited to, React components) with great reliability, use Webpack to create an auxiliary bundle and include it in the main build via foreign-libs.

• Use router5

  The router5 is a data-centric and framework-agnostic router. It supports registering on-activate and on-deactivate hooks to trigger side-effects. A common use case is to load data when you enter a page, or to clean up resources when you leave a page.

Code conventions

• The -ui suffix for function is used to indicate that the function is a Reagent component and should be used in [square-brackets].

• Every subpage of the app lives in a separate namesapce in the cljs-spa.page hierarchy. It exposes a page-ui entry point, as well as optional on-activate and on-deactivate hooks.

• A page is in one of three states: :loading, :loaded or :failed. The page-state-ui wrapper shows a spinner while loading, and a sad smiley when the on-activate promise failed.

• Rely on higher-order components like layout-ui and router-ui to hide complexity and for better composability.

Additional features

• The Home page uses the excellent react-select component to demonstrate how to use React components sourced from NPM. See code.

Links

This repository is inspired by Richard Feldman's elm-spa-example.

Don't forget to check out Figwheel Main.

License

MIT

Author

Paulus Esterhazy [e-mail]