https://github.com/kit-clj/kit
Lightweight, modular framework for scalable web development in Clojure
https://github.com/kit-clj/kit
clojure framework integrant kit-clj web
Last synced: 2 months ago
JSON representation
Lightweight, modular framework for scalable web development in Clojure
- Host: GitHub
- URL: https://github.com/kit-clj/kit
- Owner: kit-clj
- License: mit
- Created: 2021-06-18T05:20:06.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-08T15:08:04.000Z (2 months ago)
- Last Synced: 2025-03-08T16:19:44.791Z (2 months ago)
- Topics: clojure, framework, integrant, kit-clj, web
- Language: Clojure
- Homepage: https://kit-clj.github.io/
- Size: 1.15 MB
- Stars: 507
- Watchers: 15
- Forks: 47
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Kit
Lightweight, modular framework for scalable production
systems.
## Goal
The goal of Kit is to provide a template for a robust,
scalable Clojure web application. It hides common plumbing
that is standard across projects via its libs system, while
exposing code that tends to be customized in the clj-new
template.
Thanks to `integrant`, and `aero`, the libs are simple
skeletons with the bulk of the customization being done in
the system configuration EDN file.
## Quick start
Kit
requires [clj-new](https://github.com/seancorfield/clj-new),
installed preferably as a tool:
`clojure -Ttools install com.github.seancorfield/clj-new '{:git/tag "v1.2.381"}' :as clj-new`
To create a new Kit application:
`clojure -Tclj-new create :template io.github.kit-clj :name yourname/app`
## Latest versions
| Library | Latest Version |
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| io.github.kit-clj/kit-core | [](https://clojars.org/io.github.kit-clj/kit-core) |
| io.github.kit-clj/kit-hato | [](https://clojars.org/io.github.kit-clj/kit-hato) |
| io.github.kit-clj/kit-http-kit | [](https://clojars.org/io.github.kit-clj/kit-http-kit) |
| io.github.kit-clj/kit-jetty | [](https://clojars.org/io.github.kit-clj/kit-jetty) |
| io.github.kit-clj/kit-metrics | [](https://clojars.org/io.github.kit-clj/kit-metrics) |
| io.github.kit-clj/kit-nrepl | [](https://clojars.org/io.github.kit-clj/kit-nrepl) |
| io.github.kit-clj/kit-quartz | [](https://clojars.org/io.github.kit-clj/kit-quartz) |
| io.github.kit-clj/kit-redis | [](https://clojars.org/io.github.kit-clj/kit-redis) |
| io.github.kit-clj/kit-repl | [](https://clojars.org/io.github.kit-clj/kit-repl) |
| io.github.kit-clj/kit-selmer | [](https://clojars.org/io.github.kit-clj/kit-selmer) |
| io.github.kit-clj/kit-sql | [](https://clojars.org/io.github.kit-clj/kit-sql) |
| io.github.kit-clj/kit-sql-conman | [](https://clojars.org/io.github.kit-clj/kit-sql-conman) |
| io.github.kit-clj/kit-sql-hikari | [](https://clojars.org/io.github.kit-clj/kit-sql-hikari) |
| io.github.kit-clj/kit-sql-migratus | [](https://clojars.org/io.github.kit-clj/kit-sql-migratus) |
| io.github.kit-clj/kit-postgres | [](https://clojars.org/io.github.kit-clj/kit-postgres) |
| io.github.kit-clj/kit-mysql | [](https://clojars.org/io.github.kit-clj/kit-mysql) |
| io.github.kit-clj/kit-xtdb | [](https://clojars.org/io.github.kit-clj/kit-xtdb) |
| io.github.kit-clj/kit-generator | [](https://clojars.org/io.github.kit-clj/kit-generator) |
| io.github.kit-clj/lein-template | [](https://clojars.org/io.github.kit-clj/lein-template) |
| io.github.kit-clj/deps-template | [](https://clojars.org/io.github.kit-clj/deps-template) |
### Profiles
Default libs included with no profile specified:
- `kit-core`
- `kit-undertow`
Additional profiles:
- `+xtdb` - Adds the `kit-xtdb` lib
- `+hato` - Adds the `kit-hato` lib
- `+metrics` - Adds the `kit-metrics` lib
- `+quartz` - Adds the `kit-quartz` lib
- `+redis` - Adds the `kit-redis` lib
- `+selmer` - Adds the `kit-selmer` lib
- `+nrepl` - Adds the `kit-nrepl` lib
- `+socket-repl` - Adds the `kit-repl` lib
- `+sql` - Adds the default SQL libraries: `kit-sql-conman`
, `kit-sql-migratus`, and `kit-postgres` libs
- `+conman` - Adds the `kit-sql-conman` lib
- `+hikari` - Adds the `kit-sql-hikari` lib
- `+migratus` - Adds the `kit-sql-migratus` lib
- `+mysql` - Adds the `kit-sql-general` and `kit-mysql` libs
- `+full` - Adds the libs `kit-xtdb`, `kit-hato`
, `kit-metrics`, `kit-quartz`, `kit-redis`, `kit-selmer`
, `kit-repl`, `kit-sql-conman`, `kit-postgres`,
and `kit-sql-migratus`
## Libs
- `kit-core` - basic utility functions used by some other
libs
- `kit-xtdb` - Simple binding to connect to
a [XTDB](https://xtdb.com/) database node
- `kit-hato` - HTTP client
using [hato](https://github.com/gnarroway/hato)
- `kit-nrepl` - [nREPL](https://github.com/nrepl/nrepl)
component for use in a running system. e.g. to connect to
a production REPL
- `kit-metrics` - Configurable metrics
using [iapetos](https://github.com/clj-commons/iapetos)
- `kit-quartz` - Scheduler
using [cronut](https://github.com/troy-west/cronut) as an
integrant binding
for [quartz](http://www.quartz-scheduler.org/). Exposes
the `cronut` API, simply some extensions for `aero` and
utilities
- `kit-redis` - An extension
of [core.cache](https://github.com/clojure/core.cache) for
Redis
via [carmine](https://github.com/ptaoussanis/carmine)
- `kit-repl` - Socket REPL integrant binding for use in a
running system. e.g. to connect to a production REPL
- `kit-selmer` - Templating configuration
with [selmer](https://github.com/yogthos/Selmer)
- `kit-sql` - Deprecated. Use `kit-sql-conman`
and `kit-sql-migratus`. Pulls in both of these as generic
SQL integrant binding.
Uses [conman](https://github.com/luminus-framework/conman)
, [next.jdbc](https://github.com/seancorfield/next-jdbc)
, [hugsql](https://www.hugsql.org/),
and [migratus](https://github.com/yogthos/migratus)
directly, or implicitly
- `kit-sql-conman` -
Uses [conman](https://github.com/luminus-framework/conman)
, [next.jdbc](https://github.com/seancorfield/next-jdbc)
, [hugsql](https://www.hugsql.org/),
- `kit-sql-hikari` - General sql layer, just contains
connection pooling (
via [hikari-cp](https://github.com/tomekw/hikari-cp)) and
jdbc wrapper (
via [next.jdbc](https://github.com/seancorfield/next-jdbc))
.
- `kit-sql-migratus` -
uses [migratus](https://github.com/yogthos/migratus) for
SQL migrations
- `kit-postgres` - lib with data bindings and utilities for
working with Postgres
- `kit-mysql` - lib with data bindings and utilities for
working with MySQL8+
- `kit-undertow` - Server binding
via [ring-undertow-adapter](https://github.com/luminus-framework/ring-undertow-adapter)
## Build Tool Support
Presently only Clojure deps is supported, however there are
plans to add Leiningen support.
## Documentation
[Documentation can be found here](https://kit-clj.github.io)
## Emacs Integration
An [emacs package](https://github.com/jpe90/emacs-clj-deps-new) is available which provides a Magit-style interface to `clj-new` and `deps-new` and provides a command to create Kit web applications.
## Inspiration and thanks to
- [integrant](https://github.com/weavejester/integrant) as
the basis of the project
- [aero](https://github.com/juxt/aero) for powerful
configuration used throughout
- [re-frame template](https://github.com/day8/re-frame-template)
for code used directly in `kit-template`
- [Luminus framework](https://luminusweb.com/) from which
the initial project that Kit's predecessor was built upon
## License
Copyright © 2021
Released under the MIT license.