LifeInParentheses

Another go at my life calculator

Useful commands

Backend

The backend has been developed with NeoVim and the Conjure plugin. To start an nREPL that Conjure will recognise and automatically connect to, use:

clojure -M:repl

The unit tests use Kaocha test runner. To focus on a given test package, use --focus. To start the test executable in watch mode, use --watch. To run the unit tests, from the backend folder:

clojure -M:test [--focus <test package>] [--watch]

To build the backend as an executable JAR, from the backend folder:

clojure -T:build uber

Frontend

The frontend has been developed with NeoVim and the Conjure plugin. It leverages shadow-cljs for hot reloading of the code and nREPL connection.

To start the front end in developer mode, run:

npx shadow-cljs watch app

For Conjure to hook into the nREPL created by shadow-cljs, run the following in NeoVim:

:ConjureShadowSelect app

nginx

The app uses nginx as a proxy. To start the server locally, run:

nginx -g "daemon off;" -c <path to nginx.conf> -p <path to public folder>

It needs the configuration file for the app (committed to the project) and the path to the public folder (in the frontend folder). Also, nginx expects the backend to run on port 5000 and the frontend on port 8080.

From there, you can access both the frontend and the backend from port 80.

End to end tests

End-to-end tests have been written with Babashka. To run the tests, from the tests folder:

bb run-tests [path-to-backend-binary] [options]

Options notably include --port and --no-startup. Look at the help for more information.