re-frame-template

Leiningen template for reagent web apps which implement the re-frame pattern.

Through the use of profiles, this template lets the developer pick and choose what "extras" are included in their application.

Basic Usage

The base template includes:

• re-frame
• shadow-cljs
• cljs-devtools

To create an application with the base template:

lein new re-frame <project-name>

Troubleshooting note: for <project-name> don't use cljs. That name will confuse the compiler and you will (later) see errors like cljs.core.init is not a function

Extras

The optional profiles include:

• CSS
  • garden (+garden)
  • less (+less)
• Debug
  • re-frame-10x (+10x)
  • re-frisk (+re-frisk)
• Development
  • cider (+cider)
  • cljs.test (+test)
• Full-stack
  • compojure (+handler)
• Misc.
  • re-com (+re-com)
  • re-pressed (+re-pressed)
  • breaking-point (+breaking-point)
• Routing
  • secretary (+routes)

To add a profile to the base template, just append the profile name (let's use +re-com as an example):

lein new re-frame <project-name> +re-com

Any combination of profiles can be added at once:

lein new re-frame <project-name> +garden +re-com +routes +test +less +10x

Note: to assist debugging, you'll want to include either +10x or +re-frisk

Start Cider from Emacs (if using +cider):

Refer to the shadow-cljs Emacs / CIDER documentation.

The mentioned dir-local.el file is created by this template.

Compile css (if using +garden or +less):

Compile css file once.

lein garden once

lein less once

Automatically recompile css file on change.

lein garden auto

lein less auto

Run application:

Retrieve dependencies:

lein deps
yarn install  # or npm install

Then run:

lein clean
lein dev

Wait a bit, then browse to http://localhost:8280.

To see other available shadow-cljs commands run:

lein run -m shadow.cljs.devtools.cli --help

Setting Up Your Browser

So, you now have the application running.

Before you start developing, you should tweak two settings within your browser's devtools. These are one-time actions (for each browser and laptop you use). I'll assume Chrome for the purposes of further explanation:

1. Open devtools. Press press F12 or Ctrl-Shift-i (actually there's a variety of ways)
2. Open devtool's "Setting" Panel. Press F1. (Careful. Not the Setting panel for Chrome itself!! The Settings panel for devtools)
3. Under the "Network" heading, tick the option "Disable cache (while DevTools is open)". You don't want figwheel's attempts at reloading to be defeated by caching.
4. Under the "Console" heading, tick the option "Enable custom formatters". This allows cljs-devtools to perform its magic.
5. Close Settings. Close Devtools.
6. Reopen Devtools

Open 10x Panel (if using +10x):

To use re-frame-10x for debugging your app:

1. click on the application, minimal through it is, to give it "input focus" (you want to be sure that any key presses are going to your new app)
2. press Ctrl-H and you should see the re-frame-10x panel appear on the right side of the window

Sometimes achieving Step 1 on a really simple app - one without widgets - can be fiddly, because the browser itself hogs "input focus" and grabs all the keystrokes (like Ctrl-H) which don't then make it through to your app. You may need to be determined and creative with Step 1. I have every confidence in you.

Hot Reloading Is Now Go

If you now edit files, like perhaps /src/cljs/<project-name>/views.cljs, Figwheel will automatically recompile your changes and "hot load" them into your running app, without your app needing to be re-started. The resulting fast, iterative workflow tends to make you very productive, and is cherished by those lucky enough to experience it.

debug?:

In project-name.config, there is a variable called debug?, which defaults to true. However, for the min build (look inside of project.clj), this variable is re-defined to false.

When debug? is true, we include (enable-console-print!). If you, for example, you wrap your printlns with a when block as show below, then you will get logs printed to the browser's console for the dev build and not the min build.

(when config/debug?
  (println "dev mode"))

Run tests (if using +test):

Install karma and headless chrome

npm install -g karma-cli

And then run your tests

lein clean
lein run -m shadow.cljs.devtools.cli compile karma-test
karma start --single-run --reporters junit,dots

Production Build

To compile clojurescript to javascript:

lein clean
lein prod

Deploy to heroku (if using +handler)

Create uberjar

lein clean
lein with-profile prod uberjar

Create app on heroku

heroku create

Then deploy the application

git push heroku master

Other Templates

• chestnut
• luminus (full stack)
• reagent-figwheel
• reagent-seed

Backend Options

• ring and liberator
• duct
• yada
• pedestal and vase

More re-frame

Looking for more re-frame inspiration, templates or example applications? See the external resources docs page.

Contributing

Contributions are welcomed! To add a new profile, this is what I'd recommend:

1. Add a file with the name of the profile here
2. Look at the existing options in that folder for inspiration for what to include in that file
3. Update project.clj with the profile
4. Add any new files here and use the {{ var-name }} syntax as needed
5. Update the README that will result when the template is used, as well as the top-level README for re-frame-template itself
6. In a terminal, at the root of re-frame-template, run lein install
7. Locally test that your profile works, lein new re-frame <app-name> +<profile-name>
8. Add your profile to create-templates and run the script to make sure the other profiles didn't break.

License

The MIT License (MIT)

Copyright © 2015 Matthew Jaoudi
Copyright © 2015 Dylan Paris
Copyright © 2015 Michael Thompson
Copyright © 2015 Markku Rontu
Copyright © 2016 Daniel Compton
Copyright © 2019 Isaac Johnston

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.