A re-frame chat application.
- Architecture: Single Page Application (SPA)
- Languages
- Front end (re-frame): ClojureScript (CLJS)
- Back end/middleware (Compojure): Clojure
- Dependencies
- Build tools
- Project task & dependency management: Leiningen
- CLJS compilation, REPL, & hot reload:
shadow-cljs
- Test framework: cljs.test
- Test runner: Karma
- Development tools
- Debugging: CLJS DevTools,
re-frame-10x
, re-frisk - Emacs integration: CIDER
- Debugging: CLJS DevTools,
/
: project config filesdev/
: source files compiled only with the dev profilecljs/user.cljs
: symbols for use during development in the ClojureScript REPL
resources/public/
: SPA root directory; dev / prod profile depends on the most recent buildvendor/
: UI component CSS, fonts, and imagesindex.html
: SPA home page- Dynamic SPA content rendered in the following
div
:<div id="app"></div>
- Customizable; add headers, footers, links to other scripts and styles, etc.
- Dynamic SPA content rendered in the following
- Generated directories and files - Created on build with either the dev or prod profile - Deleted on
lein clean
(run by alllein
aliases before building) -css/
: compiled CSS (lein-garden
, can also be compiled manually) -js/compiled/
: compiled CLJS (shadow-cljs
) - Not tracked in source control; see.gitignore
src/clj/cljchat/
: Backend and middleware source files (Clojure, Compojure)src/cljs/cljchat/
: SPA source files (ClojureScript, re-frame)core.cljs
: contains the SPA entry point,init
test/cljs/cljchat/
: test files (ClojureScript, cljs.test)- Only namespaces ending in
-test
(files*_test.cljs
) are compiled and sent to the test runner
- Only namespaces ending in
Use your preferred editor or IDE that supports Clojure/ClojureScript development. See Clojure tools for some popular options.
- Install JDK 8 or later (Java Development Kit)
- Install Leiningen (Clojure/ClojureScript project task & dependency management)
- Install Node.js (JavaScript runtime environment)
- Install karma-cli (test runner):
npm install -g karma-cli
- Install Chrome or
Chromium version 59 or later
(headless test environment) * For Chromium, set the
CHROME_BIN
environment variable in your shell to the command that launches Chromium. For example, in Ubuntu, add the following line to your.bashrc
:bash export CHROME_BIN=chromium-browser
- Clone this repo and open a terminal in the
cljchat
project root directory - Download project dependencies:
lein deps && npm install
Browser caching should be disabled when developer tools are open to prevent interference with
shadow-cljs
hot reloading.
Custom formatters must be enabled in the browser before CLJS DevTools can display ClojureScript data in the console in a more readable way.
- Open DevTools (Linux/Windows:
F12
orCtrl-Shift-I
; macOS:⌘-Option-I
) - Open DevTools Settings (Linux/Windows:
?
orF1
; macOS:?
orFn+F1
) - Select
Preferences
in the navigation menu on the left, if it is not already selected - Under the
Network
heading, enable theDisable cache (while DevTools is open)
option - Under the
Console
heading, enable theEnable custom formatters
option
- Open Developer Tools (Linux/Windows:
F12
orCtrl-Shift-I
; macOS:⌘-Option-I
) - Open Developer Tools Settings
(Linux/macOS/Windows:
F1
) - Under the
Advanced settings
heading, enable theDisable HTTP Cache (when toolbox is open)
option
Unfortunately, Firefox does not yet support custom formatters in their devtools. For updates, follow the enhancement request in their bug tracker: 1262914 - Add support for Custom Formatters in devtools.
Start a temporary local web server, build the app with the dev
profile, and serve the app with
hot reload:
lein dev
Please be patient; it may take over 20 seconds to see any output, and over 40 seconds to complete.
When [:app] Build completed
appears in the output, browse to
http://localhost:8280/.
shadow-cljs
will automatically push ClojureScript code
changes to your browser on save. To prevent a few common issues, see
Hot Reload in ClojureScript: Things to avoid.
Opening the app in your browser starts a ClojureScript browser REPL, to which you may now connect.
Connect to the browser REPL:
M-x cider-jack-in-cljs
See
Shadow CLJS User's Guide: Emacs/CIDER
for more information. Note that the mentioned .dir-locals.el
file has already
been created for you.
See
Shadow CLJS User's Guide: Editor Integration.
Note that lein dev
runs shadow-cljs watch
for you, and that this project's running build id is
app
, or the keyword :app
in a Clojure context.
Alternatively, search the web for info on connecting to a shadow-cljs
ClojureScript browser REPL
from your editor and configuration.
For example, in Vim / Neovim with fireplace.vim
- Open a
.cljs
file in the project to activatefireplace.vim
- In normal mode, execute the
Piggieback
command with this project's running build id,:app
::Piggieback :app
-
Connect to the
shadow-cljs
nREPL:lein repl :connect localhost:8777
The REPL prompt,
shadow.user=>
, indicates that is a Clojure REPL, not ClojureScript. -
In the REPL, switch the session to this project's running build id,
:app
:(shadow.cljs.devtools.api/nrepl-select :app)
The REPL prompt changes to
cljs.user=>
, indicating that this is now a ClojureScript REPL. -
See
user.cljs
for symbols that are immediately accessible in the REPL without needing torequire
.
Build the app with the prod
profile, start a temporary local web server, launch headless
Chrome/Chromium, run tests, and stop the web server:
lein karma
Please be patient; it may take over 15 seconds to see any output, and over 25 seconds to complete.
See a list of shadow-cljs CLI
actions:
lein run -m shadow.cljs.devtools.cli --help
Please be patient; it may take over 10 seconds to see any output. Also note that some actions shown may not actually be supported, outputting "Unknown action." when run.
Run a shadow-cljs action on this project's build id (without the colon, just app
):
lein run -m shadow.cljs.devtools.cli <action> app
The debug?
variable in config.cljs
defaults to true
in
dev
builds, and false
in prod
builds.
Use debug?
for logging or other tasks that should run only on dev
builds:
(ns cljchat.example
(:require [cljchat.config :as config])
(when config/debug?
(println "This message will appear in the browser console only on dev builds."))
Build the app with the prod
profile:
lein with-profile prod uberjar
Please be patient; it may take a few seconds to see any output, and over 50 seconds to complete.
The resources/public/js/compiled
directory is created, containing the compiled app.js
and
manifest.edn
files. The target/
directory is then created, containing the
standalone cljchat.jar
.
Run the jar,
setting the port the Ring server will use by setting the environment variable, port
.
port=2000 java -jar target/cljchat.jar
If port
is not set, the server will run on port 3000 by default.
-
heroku create
-
git push heroku master