{"id":18456901,"url":"https://github.com/bhauman/figwheel-main-template","last_synced_at":"2025-05-16T18:07:29.787Z","repository":{"id":32685257,"uuid":"137278885","full_name":"bhauman/figwheel-main-template","owner":"bhauman","description":"A template to generate a minimal figwheel-main based ClojureScript project","archived":false,"fork":false,"pushed_at":"2025-02-09T22:32:23.000Z","size":88,"stargazers_count":87,"open_issues_count":4,"forks_count":19,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-27T17:16:51.219Z","etag":null,"topics":["clojure","clojurescript","figwheel","reactjs","template"],"latest_commit_sha":null,"homepage":"http://rigsomelight.com/figwheel-main-template/","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bhauman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["bhauman"]}},"created_at":"2018-06-13T22:37:36.000Z","updated_at":"2025-02-09T22:32:26.000Z","dependencies_parsed_at":"2024-11-06T08:13:01.538Z","dependency_job_id":"d12b2a62-c5ea-47d1-a051-403c9cedc3c5","html_url":"https://github.com/bhauman/figwheel-main-template","commit_stats":{"total_commits":82,"total_committers":15,"mean_commits":5.466666666666667,"dds":"0.20731707317073167","last_synced_commit":"8a65deae2150f968e0b50a722e5533e1b8ef9b52"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bhauman%2Ffigwheel-main-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bhauman%2Ffigwheel-main-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bhauman%2Ffigwheel-main-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bhauman%2Ffigwheel-main-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bhauman","download_url":"https://codeload.github.com/bhauman/figwheel-main-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247052619,"owners_count":20875685,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clojure","clojurescript","figwheel","reactjs","template"],"created_at":"2024-11-06T08:12:59.313Z","updated_at":"2025-04-03T18:14:09.061Z","avatar_url":"https://github.com/bhauman.png","language":"Clojure","funding_links":["https://github.com/sponsors/bhauman"],"categories":[],"sub_categories":[],"readme":"# figwheel.main template\n\nA template generator that will produce a minimal ClojureScript project\nthat includes\n[figwheel.main](https://figwheel.org)\ntooling.\n\n## Abridged Usage Examples\n\nAlready an expert? Can't stand to read more information? Assuming you have [lein](https://github.com/technomancy/leiningen) or [clj-new](https://github.com/seancorfield/clj-new) installed, you can use one of the following commands:\n\n```shell\nclj -Tclj-new create :template figwheel-main :name yourname/hello-world :args '[\"+lein\", \"--react\"]' # or --rum, --reagent or nothing\n```\n\nor\n\n```shell\nlein new figwheel-main hello-world.core -- +deps --react # or --rum, --reagent or nothing\n```\n\n## Overview\n\nThe `figwheel-main` template is intended to get you up and running\nwith a no-frills ClojureScript project initialized with the\nClojureScript React framework of your choosing. It is intended to work\nequally well with\n[Leiningen](https://github.com/technomancy/leiningen) or\n[clj-new](https://github.com/seancorfield/clj-new).\n\n\n## Usage\n\n#### Using clj-new\n\nMake sure you have\n[installed the Clojure CLI tools](https://clojure.org/guides/getting_started#_clojure_installer_and_cli_tools)\nand are running the latest version.\n\nAlso, ensure you have installed [clj-new](https://github.com/seancorfield/clj-new) as detailed [here](https://github.com/seancorfield/clj-new#getting-started). The following creates a project subfolder \"hello-world\" and a project using \"yourname\" as root namespace:\n\n\tclj -Tclj-new create :template figwheel-main :name yourname/hello-world :args '[\"+lein\", \"--react\"]'\n\n\n#### Using lein\n\nMake sure you have the\n[latest version of Leiningen installed](https://github.com/technomancy/leiningen#installation).\n\n    lein new figwheel-main hello-world.core -- +deps --react\n\n### Options\n\nTakes a **name** and possibly a single **framework** option with the\nform `--framework` and any number of **attribute** options of the form\n`+attribute` and produces a minimal ClojureScript project that\nincludes Figwheel Main tooling\n\nThe initial **name** option is intended to be the name of your initial\nproject namespace. Here are some examples of valid project names:\n\n\thello.core\n\tmy.group/dominate.world\n\nThe framework options are:\n\n     --react   which adds a minimal React/Sablono application in core.cljs\n     --reagent which adds a minimal Reagent application in core.cljs\n     --rum     which adds a minimal Rum application in core.cljs\n\nThe attribute options are:\n\n     +npm-bundle  which sets up a build that utilizes npm modules\n     +deps        which generates a deps.edn (a default when used with clj-new)\n     +lein        which generates a project.clj (a default when used with lein)\n     +bare-index  which generates an index without any annoyingly helpful content\n\nOnly one **framework** option can be specified at a time. If no\nframework option is specified, nothing but a print statment is added\nto the generated ClojureScript code.\n\nExamples:\n\n    lein new figwheel-main hello-world.core -- +deps --react\n\n    clj -Xclj-new create :template figwheel-main :name yourname/hello-world :args '[\"+bare-index\",\"+lein\",\"--react\"]'\n\n# Compiling the generated project\n\n\u003e When using `+npm-bundle` you must run `npm install` before building your project\n\n### With a CLI tools project\n\nTo get an interactive development environment change into the project\nroot (the directory just created) and execute:\n\n    clojure -M:fig:build\n\nAfter the compilation process is complete, and a browser has popped\nopen the compiled project in your browser, you will get a ClojureScript\nREPL prompt that is connected to the browser.\n\nAn easy way to verify this is:\n\n    cljs.user=\u003e (js/alert \"Am I connected?\")\n\nand you should see an alert in the browser window.\n\nYou can also supply arguments to `figwheel.main` like so (this is equivalent to `clojure -A:fig:build` above):\n\n    clojure -M:fig -m figwheel.main -b dev -r\n\nTo clean all compiled files:\n\n    rm -rf target/public\n\nTo create a production build:\n\n    rm -rf target/public\n    clojure -M:fig:min\n\n### With Leiningen based project\n\nTo get an interactive development environment change into the project\nroot (the directory just created) and execute:\n\n    lein fig:build\n\nAfter the compilation process is complete, and a browser has popped\nopen the compiled project in your browser, you will get a ClojureScript\nREPL prompt that is connected to the browser.\n\nAn easy way to verify this is:\n\n    cljs.user=\u003e (js/alert \"Am I connected?\")\n\nand you should see an alert in the browser window.\n\nYou can also supply arguments to `figwheel.main` like so:\n\n\tlein fig -- -b dev -r\n\nTo clean all compiled files:\n\n\tlein clean\n\nTo create a production build:\n\n\tlein clean\n   \tlein fig:min\n\n# Testing\n\nYour initial tests are in the `test` directory. You will have tests\nthat are updated live with each file change if you open a tab to\n`http://localhost:9500/figwheel-extra-main/auto-testing`\n\nYou can run your tests from the command line with:\n\n    clj -M:fig:test\n\nor with `lein`:\n\n    lein fig:test\n\n## Questions?\n\nSee the [`figwheel.main` documentation](https://figwheel.org)\n\nHit me up on the [Clojurians Slack](http://clojurians.net/) on the `#figwheel-main` channel.\n\n## License\n\nCopyright © 2018 Bruce Hauman\n\nDistributed under the Eclipse Public License either version 1.0 or (at\nyour option) any later version.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhauman%2Ffigwheel-main-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbhauman%2Ffigwheel-main-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhauman%2Ffigwheel-main-template/lists"}