Brandon Wong b8ffc6fe30 continuing work on control panel; fixed error in cell eval function | 4 years ago | |
---|---|---|
.. | ||
dev | 4 years ago | |
resources | 4 years ago | |
src | 4 years ago | |
.gitignore | 4 years ago | |
README.md | 4 years ago | |
karma.conf.js | 4 years ago | |
package-lock.json | 4 years ago | |
package.json | 4 years ago | |
project.clj | 4 years ago | |
shadow-cljs.edn | 4 years ago |
A re-frame application designed to ... well, that part is up to you.
shadow-cljs
/
: project config filesdev/
: source files compiled only with the dev profile
cljs/user.cljs
: symbols for use during development in the
ClojureScript REPLresources/public/
: SPA root directory;
dev / prod profile depends on the most recent build
index.html
: SPA home pagediv
:
html
<div id="app"></div>
lein clean
(run by all lein
aliases before building)js/compiled/
: compiled CLJS (shadow-cljs
)
.gitignore
src/cljs/microtables_frontend/
: SPA source files (ClojureScript,
re-frame)
core.cljs
: contains the SPA entry point, init
Use your preferred editor or IDE that supports Clojure/ClojureScript development. See Clojure tools for some popular options.
microtables-frontend
project root directorysh
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.
F12
or Ctrl-Shift-I
; macOS: ⌘-Option-I
)?
or F1
; macOS: ?
or Fn+F1
)Preferences
in the navigation menu on the left, if it is not already selectedNetwork
heading, enable the Disable cache (while DevTools is open)
optionConsole
heading, enable the Enable custom formatters
optionF12
or
Ctrl-Shift-I
; macOS: ⌘-Option-I
)F1
)Advanced settings
heading, enable the Disable HTTP Cache (when toolbox is open)
optionUnfortunately, 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.
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
.cljs
file in the project to activate fireplace.vim
Piggieback
command with this project's running build id, :app
:
vim
: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 to require
.
shadow-cljs
ActionsSee 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 microtables-frontend.example
(:require [microtables-frontend.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 prod
Please be patient; it may take over 15 seconds to see any output, and over 30 seconds to complete.
The resources/public/js/compiled
directory is created, containing the compiled app.js
and
manifest.edn
files.
The resources/public
directory contains the complete, production web front
end of your app.
Always inspect the resources/public/js/compiled
directory prior to deploying the app. Running any
lein
alias in this project after lein dev
will, at the very least, run lein clean
, which
deletes this generated directory. Further, running lein dev
will generate many, much larger
development versions of the files in this directory.