Skip to content
This repository has been archived by the owner on Jan 5, 2023. It is now read-only.

Latest commit

 

History

History
132 lines (97 loc) · 3.79 KB

README.adoc

File metadata and controls

132 lines (97 loc) · 3.79 KB
Raw

Star Trek Clojure/script Project

Table of Contents

1. Stop!

I would recommend that attention is given to the startrek project instead of this one.

The startrek project uses Donut instead of Clip. It’s also far more complete in handling errors, doing i18n, has tests showing how to mock ring requests and so on. Going forward, only the startrek project will be maintained.

Saying that, if you do want to continue to refer to this one (but bring in ideas found in the startrek project) by all means enjoy!

2. Introduction

This is a very small, yet surprisingly complete, example of using Clojure to serve up a RESTful API. It uses a variety of technologies to demonstrate how this is possible. The project offers a full CRUD (Create, Read, Update and Delete) experience over some Star Trek starships!

3. Features

  • CRUD Functionality

  • Exception Handling

  • Internationalisation (i18n)

  • Swagger API

  • Input Validation (using Malli)

3.1. Star Trek

This backend is written in Clojure and uses a PostgreSQL database to store a list of starships. The technologies in play include:

A full list of the technologies that are used can be found in the deps.edn file.

This service also exposes Prometheus metrics AND a JMX endpoint for your enjoyment!

3.2. Star Trek UI

A companion project is available on github that exposes a UI written in ClojureScript. It’s highly recommended that you look at that project too and see if you can get them both working together! 😀

3.3. Engage!

There are at least 3 ways to launch this project:

3.3.1. Option 1

❗
 You need to copy the resources/config/config-example.edn to resources/config/config-local.edn and modify, for example, if you are connecting to your own PostgreSQL instance.

Fire up a REPL and connect to it. Open up the main.clj file in your editor and evaluate the (do ,,,) block contained within the (comment ,,,) rich comment block.

3.3.2. Option 2

❗
 You need to copy the resources/config/config-example.edn to resources/config/config-local.edn and modify, for example, if you are connecting to your own PostgreSQL instance.

  • bin/build

  • bin/run-local

3.3.3. Option 3

❗
 You don’t need to copy any config file, as the docker container is configured to use config/config-example.edn, and thus this is the one by the application.

  • bin/build

  • bin/run-docker

4. License

Find the full unlicense in the UNLICENSE (and LICENSE) file, but here’s a snippet:

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

5. Feedback

I welcome feedback. I can usually be found hanging out in the #clojure-uk channel on Clojurians Slack. You can also email me if you wish :-)

6. Finally!

Live Long and Prosper!