Skip to content

ndevreeze/starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

starter

What

Clojure and Genie starter kit - containing up-to-date versions of most used libraries in (Genie) scripts and Clojure applications.

Why?

When new versions of libraries appear, need to update a lot of project.clj and deps.edn files. Also the versions might be conflicting, especially in a Genie process where many scripts can run.

Some goals:

  • Only include this starter library in Genie scripts.
  • Updates to libraries only in this starter-library
  • Script automatically get the newest versions by using this starter.

Installation

Leiningen/Boot

[ndevreeze/starter "0.1.0-SNAPSHOT"]

Clojure CLI/deps.edn

ndevreeze/starter {:mvn/version "0.1.0-SNAPSHOT"}

https://img.shields.io/clojars/v/ndevreeze/starter.svg

The SNAPSHOT is by design, so new versions will be added automatically. At some point it might be needed to freeze a version.

Usage

Require:

(ns my.namespace
   (:require [ndevreeze.starter :as starter]))

Then require namespaces in the standard way.

Developing

Testing

$ lein midje

or:

$ lein repl (or start in Cider)
(use 'midje.repl)
(autotest)

API Docs

See codox generated API docs And cljdoc too: https://cljdoc.org/d/ndevreeze/starter/0.1.0-SNAPSHOT/api/ndevreeze

(change the version and visit the cljdoc link to generate new docs for new version)

Mostly not needed, just a few functions are available for checking if we have the right version.

Creating docs

lein codox
# commit and push to github
# wait a few minutes for github to push to ndvreeze.github.io

Also build Clojars docs from the site: https://cljdoc.org/d/ndevreeze/starter/0.1.0-SNAPSHOT/doc/readme

Create a Github release

https://github.com/ndevreeze/starter/releases/new

Also create a tag for this release. Do a git pull to get tag locally after creating it online.

Publish to Clojars

lein deploy clojars

Bugs

  • No known errors. Use Github issues if you want to report a bug.

Related and similar projects (libraries)

Version history

  • 0.1.0-SNAPSHOT - First version, as try-out for Genie scripts.

License

Copyright © 2024 Nico de Vreeze.

Distributed under the Eclipse Public License, the same as Clojure.

About

Starter-kit mostly for Genie scripts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published