Liking cljdoc? Tell your friends :D

Contribution

Development dependencies

Mandatory

  • Clojure 1.10
  • Postgresql >= 11.5
  • leiningen >= 2.9.0
  • Docker >= 19.03.11
  • Docker-compose >= 1.21.0

Libraries

Mandatory

NameVersionRelated
funcool/cuerdasRELEASEString manipulation
metosin/reitit0.5.12Routes
potemkin/potemkin0.4.5Helper
com.draines/postal2.0.4Email
duct/server.http.jetty0.2.1WebServer
seancorfield/next.jdbc1.1.613WebServer
honeysql/honeysql1.0.444PostGreSQL
nilenso/honeysql-postgres0.2.6PostGreSQL
org.postgresql/postgresql42.2.2PostGreSQL
crypto-password/crypto-password0.2.1Security

Optional

NameVersionProvide
clj-kondo/clj-kondoRELEASETests

Setup

$ git clone git@github.com:Flexiana/framework.git; cd framework
$ ./script/auto.sh -y all

The first command will clone Flexiana/framework repository and jump to its directory. The second command calls auto.sh script to perform the following sequence of steps:

  1. Download the necessary docker images
  2. Instantiate the database container
  3. Import the initial SQL schema: ./docker/sql-scripts/init.sql
  4. Populate the new schema with 'fake' data from: ./docker/sql-scripts/test.sql
  5. Call lein test that will download the necessary Clojure dependencies and executes unitary tests.

See ./script/auto.sh help for more advanced options.

Remember it's necessary to have docker & docker-compose installed in your host machine. Docker daemon should be running. The chain of commands fails otherwise. It should also be noted that after the first installation everything will be cached preventing unnecessary rework, it's possible to run only the tests, if your development environment is already up, increasing the overall productivity.

./script/auto.sh -y tests

leiningen

Using lein directly is very simple:

lein test

The available commands (aliases):

AliasDescription
testExecuting tests with kaocha
fix-stylefix styling with clj-style
check-stylecheck styling with clj-style
pre-hookExecuting check-style and test aliases

Can you improve this documentation? These fine people already did:
Krisztian Gulyas & Stas Makarov
Edit on GitHub

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

× close