@@ -1,4 +1,4 @@
|
||||
# vibe
|
||||
# tbd
|
||||
|
||||
A small Clojure HTTP API built on [Ring](https://github.com/ring-clojure/ring) (Jetty) and
|
||||
[reitit](https://github.com/metosin/reitit), with Swagger UI docs, unit tests, dockerized
|
||||
@@ -24,8 +24,8 @@ PORT=8080 clojure -X:run
|
||||
Or build and run the container:
|
||||
|
||||
```bash
|
||||
docker build -t vibe .
|
||||
docker run --rm -p 3000:3000 vibe
|
||||
docker build -t tbd .
|
||||
docker run --rm -p 3000:3000 tbd
|
||||
```
|
||||
|
||||
## API
|
||||
@@ -80,7 +80,7 @@ collected.
|
||||
## Project layout
|
||||
|
||||
```
|
||||
src/vibe/
|
||||
src/tbd/
|
||||
core.clj Router, Ring app, and server startup
|
||||
<group>/routes.clj Each route group (health, math, ...) owns its route subtree
|
||||
<group>/core.clj Business logic for the group, with no HTTP concerns
|
||||
@@ -89,5 +89,5 @@ integration-test/ Dockerized integration tests and coverage harness
|
||||
script/ Bash entry points (test, coverage, repl, ...) and coverage helpers
|
||||
```
|
||||
|
||||
To add a new group, create `vibe.<group>.routes` with a `routes` fn that returns a reitit route
|
||||
vector, then add it to the router in `src/vibe/core.clj`.
|
||||
To add a new group, create `tbd.<group>.routes` with a `routes` fn that returns a reitit route
|
||||
vector, then add it to the router in `src/tbd/core.clj`.
|
||||
|
||||
Reference in New Issue
Block a user