https://github.com/Day8/re-frame-template

A Leiningen template for creating a re-frame application (client only) with a shadow-cljs build.
https://github.com/Day8/re-frame-template

cider cljs-devtools clojurescript re-frame reagent shadow-cljs

Last synced: about 1 month ago
JSON representation

A Leiningen template for creating a re-frame application (client only) with a shadow-cljs build.

• Host: GitHub
• URL: https://github.com/Day8/re-frame-template
• Owner: day8
• License: mit
• Created: 2015-03-02T21:30:15.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-27T10:48:08.000Z (2 months ago)
• Last Synced: 2024-05-08T19:09:17.539Z (about 2 months ago)
• Topics: cider, cljs-devtools, clojurescript, re-frame, reagent, shadow-cljs
• Language: Clojure
• Homepage:
• Size: 1.19 MB
• Stars: 579
• Watchers: 22
• Forks: 89
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Lists

• awesome-clojure - re-frame-template - Leiningen template for reagent web app based on the re-frame pattern (tools)

README

        

[![Clojars Project](https://img.shields.io/clojars/v/re-frame/lein-template?style=for-the-badge&logo=clojure&logoColor=fff)](https://clojars.org/re-frame/lein-template)

[![GitHub issues](https://img.shields.io/github/issues-raw/day8/re-frame-template?style=for-the-badge&logo=github)](https://github.com/day8/re-frame-template/issues)

[![GitHub](https://img.shields.io/github/license/day8/re-frame-template?style=for-the-badge)](https://github.com/day8/re-frame-template/blob/master/LICENSE)

# re-frame-template

This is a `Leiningen` template for creating a [re-frame](https://github.com/day8/re-frame) application scaffold (client only)

with a [shadow-cljs](https://shadow-cljs.github.io/docs/UsersGuide.html) build.  

It will take you 60 seconds to create your first re-frame app and start to edit it.

You can pick and choose what "extras" you'd like included into the scaffold - "extras" like libraries to do routing, debugging and CSS.

## Before You Start

You'll need to install `Leiningen` (a build tool) by following [these instructions](https://purelyfunctional.tv/guide/how-to-install-clojure/).

You'll also need [Node.js](https://nodejs.org/en/download/).

## Basic Usage

The base template includes:

* [re-frame](https://github.com/day8/re-frame)

* [shadow-cljs](https://shadow-cljs.github.io/docs/UsersGuide.html)

* [cljs-devtools](https://github.com/binaryage/cljs-devtools)

To create an application with just the base template, use this commandline:

```sh

$ lein new re-frame 

```

When using this command, you'll need to substitute in your own `` - perhaps `my-killer-app` or `an-early-masterpiece`.

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

## Extras

The following "extras" can be nominated on the commandline when you create the template:

* CSS

  * [garden](https://github.com/noprompt/garden) with [spade](https://github.com/dhleong/spade) (`+garden`)

* Debug

  * [re-frame-10x](https://github.com/day8/re-frame-10x) (`+10x`)

  * [re-frisk](https://github.com/flexsurfer/re-frisk) (`+re-frisk`)

* Development

  * [cider](https://github.com/clojure-emacs/cider) (`+cider`)

  * [clj-kondo](https://github.com/borkdude/clj-kondo) (`+kondo`)

  * [cljs.test](https://github.com/clojure/clojurescript/blob/master/src/main/cljs/cljs/test.cljs) (`+test`)

  * [git-inject](https://github.com/day8/shadow-git-inject) (`+git-inject`)

* Misc.

  * [re-com](https://github.com/day8/re-com) (`+re-com`)

  * [re-pressed](https://github.com/gadfly361/re-pressed) (`+re-pressed`)

  * [breaking-point](https://github.com/gadfly361/breaking-point) (`+breaking-point`)

  * [github-actions](https://github.com/features/actions) (`+github-actions`)

* Routing

  * [bidi](https://github.com/juxt/bidi) and [pushy](https://github.com/clj-commons/pushy) (`+routes`)

To add an `extra` to the base template, append its name to the commandline, with a leading `+`. Here's an example of adding `re-com`:

```

lein new re-frame  +re-com

```

Note: it is `+re-com`, not just `re-com`.

Any combination of `extras` can be added at once:

```

lein new re-frame  +garden +re-com +routes +test +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](https://shadow-cljs.github.io/docs/UsersGuide.html#cider).

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

## Connect Calva from VS Code:

[Calva](https://github.com/BetterThanTomorrow/calva) has built-in support for `shadow-cljs` projects (that's why there is no `+calva` option for creating this project). 

0. `npm install`

1. From VS Code, issue the command **Calva: Start a Project REPL and Connect (a.k.a Jack-in)**, `ctrl+alt+c ctrl+alt+j`.

   * Calva will auto-detect that this is a `shadow-cljs` project and ask for which build to compile.

   * Calva's output window will open and log some progress information.

1. When prompted for which build to start, select `:app`.

   * `:app` is the only configured build, but the VS Code menu for this is a bit strange so _make sure the `:app` checkbox is really ticked before proceeding_.

   * This will start the app, so in this workflow you don't do the **Run application** steps outlined below.

1. When prompted for which build to connect to, select `:app`.

    * In the **View** menu of VS Code, you can tell it to show the **Terminal** view, where you see which command the jack-in process is started with, and it's output. `Ctrl+C` in this pane will kill your app and free up all resources it has allocated.

1. When the app is compiled

    1. Open http://localhost:8280 in your browser.

    1. Confirm that it says *Hello from re-frame*. (Depending on how long the app takes to compile, you might need to reload the page a few times.)

1. Open the `views.cljs` file from `src/` and issue **Calva: Load Current File and Dependencies**. `ctrl+alt+c enter`.

    1. Confirm that you are connected by adding evaluating `(js/alert "Hello from Calva")` (`alt+enter` and `ctrl+enter` are your friends).

    1. Confirm that Shadow is hot reloading by changing the greeting message.

See https://calva.io for more on how to use Calva.

## Run application:

```sh

npm install

npm run watch

```

or

```sh

npm install

npx shadow-cljs watch app browser-test karma-test

```

Wait a bit, perhaps 20 seconds, keeping an eye out for a sign the compile has finished, then browse to [http://localhost:8280](http://localhost:8280).

To see the other available `shadow-cljs` commands run:

```

npx shadow-cljs --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](https://developer.chrome.com/devtools))

1. Open the devtools "Settings" panel. Press F1. (Careful. Not the settings panel for Chrome itself!! The settings panel for devtools)

1. Under the "Network" heading, tick the option "Disable cache (while DevTools is open)". You don't want shadow-clj's attempts at reloading to be defeated by caching.

1. Under the "Console" heading, tick the option "Enable custom formatters". This allows [cljs-devtools](https://github.com/binaryage/cljs-devtools) to perform its magic.

1. Close Settings. Close Devtools.

1. Reopen Devtools

![settings](docs/images/devtools-settings.png)

## 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-Shift-X` 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-Shift-X`) 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, shadow-cljs 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.

Start by editing this file: `/src/cljs//views.cljs`.

### debug?:

In the namespace _app-name.config_, there is a var called `debug?`, which defaults to

_true_ in the `dev` build, and _false_ in the `prod` build.

If, for example, you wrap your `println`s with a `when` block as shown below,

then you will get logs printed to the browser's console for the `dev` build and

not the `prod` build.

```clojure

(when config/debug?

  (println "dev mode"))

```

## Run tests (if using +test):

Run your tests

```

npm install

npm run watch

```

And in another terminal:

```

karma start

```

## GitHub Actions

After a push, head to the actions section of GitHub repo to see the pipeline processing.

## Production Build

To compile clojurescript to javascript:

```sh

npm run release

```

## How to Add Dependencies

Your new application is built by a tool chain controlled by [shadow-cljs](http://shadow-cljs.org/) (a modern CLJS compiler).

There are two files of interest:

  -  `shadow-cljs.edn` - edit this file if you want to add Clojure and ClojureScript dependency as [you would for a normal

Leiningen project](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md#dependencies).

  - `package.json` - edit this file if you want to add a JavaScript and NPM dependency.

## Other Templates

* [chestnut](https://github.com/plexus/chestnut)

* [luminus](https://github.com/luminus-framework/luminus-template)  (full stack)

* [reagent-figwheel](https://github.com/gadfly361/reagent-figwheel)

* [reagent-seed](https://github.com/gadfly361/reagent-seed)

## Backend Options

This template does NOT include a backend. You may want to look at the following for backend options:

* [ring](https://github.com/ring-clojure/ring) and [liberator](http://clojure-liberator.github.io/liberator/)

* [duct](https://github.com/duct-framework/duct)

* [yada](https://github.com/juxt/yada)

* [pedestal](https://github.com/pedestal/pedestal) and [vase](https://github.com/cognitect-labs/vase)

## More re-frame

Looking for more re-frame inspiration, templates or example applications?

See the [external resources](https://github.com/day8/re-frame/blob/master/docs/External-Resources.md) 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](https://github.com/day8/re-frame-template/tree/master/src/leiningen/new/options)

2. Look at the existing options in that folder for inspiration for what to include in that file

3. Update [re_frame.clj](https://github.com/day8/re-frame-template/blob/master/src/leiningen/new/re_frame.clj) with the profile

4. Add any new files [here](https://github.com/day8/re-frame-template/tree/master/src/leiningen/new/re_frame) and use the {{ var-name }} syntax as needed

5. Update the [README](https://github.com/day8/re-frame-template/tree/master/src/leiningen/new/re_frame) that will result when the template is used, as well as the top-level [README](https://github.com/day8/re-frame-template/blob/master/README.md) 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  +`

8. Add your profile to [create-templates](https://github.com/day8/re-frame-template/blob/master/create-templates.sh) and run the script to make sure the other profiles didn't break.

## License

```

The MIT License (MIT)

Copyright © 2015-2018 Matthew Jaoudi

Copyright © 2015 Dylan Paris

Copyright © 2015 Michael Thompson

Copyright © 2015 Markku Rontu

Copyright © 2016 Daniel Compton

Copyright © 2019-2021 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.

```