Skip to content

Clojure microservice implementing: Components, Reitit, Pedestal, Schema, PostgreSQL and Tests

License

Notifications You must be signed in to change notification settings

abreparenteses/financial-module.backend

Repository files navigation

financial-module

Clojure microservice implementing: Components, Reitit, Pedestal, Schema, PostgreSQL and Tests

About this project

  • financial-module: With ports and adapters architecture, this project is a simple financial module that allows you to register and manipulate accounts payable (and receivable in the future - if possible).

  • parenthesin/components: Helpers and component wrappers to give a foundation to create new services in clojure, you can find components for database, http, webserver and tools for db migrations.

Verb URL Description
POST /login login with your username and password
GET /accounts-payable get all accounts payable
POST /accounts-payable create a new account payable
GET /accounts-payable/{id} get an account payable by id
PUT /accounts-payable/{id} update an account payable by id
DELETE /accounts-payable/{id} delete an account payable by id

Repl

To open a nrepl

clj -M:nrepl

To open a nrepl with all test extra-deps on it

clj -M:test:nrepl

Run Tests

To run unit tests inside ./test/unit

clj -M:test :unit

To run integration tests inside ./test/integration

clj -M:test :integration

To run all tests inside ./test

clj -M:test

To generate a coverage report

clj -M:test --plugin kaocha.plugin/cloverage

Lint fix and format

clj -M:clojure-lsp format
clj -M:clojure-lsp clean-ns
clj -M:clojure-lsp diagnostics

Migrations

To create a new migration with a name

clj -M:migratus create migration-name

To execute all pending migrations

clj -M:migratus migrate

To rollback the latest migration

clj -M:migratus rollback

See Migratus Usage for documentation on each command.

Docker

Start containers with postgres user: postgres, password: postgres, hostname: db, port: 5432
and pg-admin email: pg@pg.cc, password: pg, port: 5433

docker-compose -f docker/docker-compose.yml up -d

Stop containers

docker-compose -f docker/docker-compose.yml stop

Running the server

First you need to have the database running, for this you can use the docker command in the step above.

Repl

You can start a repl open and evaluate the file src/financial_module/server.clj and execute following code:

(start-system! (build-system-map))

Uberjar

You can generate an uberjar and execute it via java in the terminal:

# genarate a target/service.jar
clj -T:build uberjar
# execute it via java
java -jar target/service.jar

Features

System

Tests & Checks

Directory Structure

./
├── .clj-kondo -- clj-kondo configuration and classes
├── .lsp -- clojure-lsp configuration
├── .github
│   └── workflows -- Github workflows folder.
├── docker -- docker and docker-compose files for the database
├── resources -- Application resources assets folder and configuration files.
│   └── migrations -- Current database schemas, synced on service startup.
├── src -- Library source code and headers.
│   └── financial_module -- Source for the service example.
└── test -- Test source code.
    ├── integration -- Integration tests source (uses state-flow).
    │   └── financial_module -- Tests for service example.
    └── unit -- Unity tests source (uses clojure.test).
        └── financial_module -- Tests for service example.

Related

Official Template

License

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

About

Clojure microservice implementing: Components, Reitit, Pedestal, Schema, PostgreSQL and Tests

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published