Liking cljdoc? Tell your friends :D

cc.delboni/helix-scratch

Minimal Helix Scratch Template.

TL;DR

To use this template:

  clojure -X:new :template cc.delboni/helix-scratch :name myusername/mynewproject

Requirements

Install deps-new

To you use this template you need to have installed deps-new in your workflow.

Traditional installation

clojure -Ttools install io.github.seancorfield/deps-new '{:git/tag "v0.4.13"}' :as new

Optimal installation

This is just a personal preference, but I preffer install tools adding the following as :alias into your local ~/.clojure/deps.edn file:

:new {:extra-deps {io.github.seancorfield/deps-new
                   {:git/url "https://github.com/seancorfield/deps-new"
                    :git/sha "21bb2c8e9b898f6b93506cd128314585a98cc962"}}
      :exec-fn org.corfield.new/create
      :exec-args {:template "app"}}

Usage

Remote

  # traditional install
  clojure -A:somealias -Tnew create :template cc.delboni/helix-scratch :name myusername/mynewproject

  # optimal install
  clojure -X:new :template cc.delboni/helix-scratch :name myusername/mynewproject

Local

Clone this repo, navigate into it's folder and then run:

  # traditional install
  clojure -Sdeps '{:deps {cc.delboni/helix-scratch {:local/root "."}}}' -Tnew create :template cc.delboni/helix-scratch :name myusername/mycoollib

  # optimal install
  clojure -Sdeps '{:deps {cc.delboni/helix-scratch {:local/root "./"}}}' -X:new :template cc.delboni/helix-scratch :name myusername/mycoolsite

Contributing

Build / Deploy

  # Build
  clj -X:build :lib cc.delboni/helix-scratch :version '"0.1.0"'
  # Deploy
  env CLOJARS_USERNAME=username CLOJARS_PASSWORD=clojars-token clj -X:deploy :lib delboni/helix-scratch :version '"0.1.0"'

License

Copyright © 2023 Rafael Delboni

This is free and unencumbered software released into the public domain. For more information, please refer to http://unlicense.org

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close