Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bhauman/figwheel-template
A Leinigen template for figwheel
https://github.com/bhauman/figwheel-template
Last synced: 5 days ago
JSON representation
A Leinigen template for figwheel
- Host: GitHub
- URL: https://github.com/bhauman/figwheel-template
- Owner: bhauman
- License: epl-1.0
- Created: 2014-04-30T17:27:17.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-06-14T23:46:16.000Z (over 3 years ago)
- Last Synced: 2024-05-02T00:05:28.586Z (8 months ago)
- Language: Clojure
- Size: 120 KB
- Stars: 137
- Watchers: 7
- Forks: 28
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# figwheel-template
A Leinigen template to get started with [Figwheel](https://github.com/bhauman/lein-figwheel).
## Usage
Make sure you have the [latest version of leiningen installed](https://github.com/technomancy/leiningen#installation).
lein new figwheel hello-world
### Options
--react Adds a bare bones React app, including Sablono.
--reagent Adds a bare bones Reagent app.
--rum Adds a bare bones Rum app.
+bundle Generates a project with npm and webpack support.
Include the options using `--` to separate them from Leiningens
options, like so
lein new figwheel hello-world -- --reagent
## Usage
To get an interactive development environment run
npm install
and then
lein figwheel
from the project root directory.
Wait ... until the project finishes compiling and then ...
open your browser at [localhost:3449/index.html](http://localhost:3449/index.html).
Figwheel will now be running and will auto compile and send all
changes to the browser without the need to reload.
After the compilation process is complete, and you have loaded the
compiled project in your browser you will get a ClojureScript REPL
prompt that is connected to the browser.
An easy way to verify this is:
(js/alert "Am I connected?")
and you should see an alert in the browser window.
To clean all compiled files:
lein clean
To create a production build run:
lein do clean, cljsbuild once min
And open your browser in `resources/public/index.html`. You will not
get live reloading, nor a REPL.
## Npm dependencies
The generated project is compatible with Webpack and npm and you can
add JavaScript dependencies via the normal `npm install` route.
## From the Clojure REPL
Alternatively you can lauch Figwheel from the REPL.
If you run `lein repl` a Clojure REPL will launch.
From this REPL prompt you can run
```
user> (fig-start)
```
and this will launch figwheel but will not launch the ClojureScript
REPL.
You can launch the Figwheel ClojureScript REPL like so:
```
user> (cljs-repl)
```
Please see `dev/user.clj` for more information.
Note: you should always run `lein figwheel` to verify that you have
setup everything correctly.
## License
Copyright © 2020 Bruce Hauman
Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.