33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
|
# Leiningen Template: Simple Clojure Web Service
|
||
|
|
|
||
|
|
A Leiningen template intended for creating new Clojure web service projects utilizing [reitit](https://github.com/metosin/reitit).
|
||
|
|
|
||
|
|
This template primarily exists for my own personal use, so some stuff is definitely more oriented towards
|
||
|
|
my own particular preferences regarding setup and organization of a Clojure project.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```text
|
||
|
|
$ lein new net.gered/simple-web-service [your-project-name-here]
|
||
|
|
```
|
||
|
|
|
||
|
|
The resulting project starts up via a `main` function and during startup expects to be able to read an EDN
|
||
|
|
configuration file located in the current working directory called `config.edn`.
|
||
|
|
|
||
|
|
The project can be run simply by:
|
||
|
|
|
||
|
|
```text
|
||
|
|
$ lein run
|
||
|
|
```
|
||
|
|
|
||
|
|
A nREPL server will be started which can be connected to on port 7000 (configured via the aforementioned `config.edn`).
|
||
|
|
|
||
|
|
The web service's endpoints will be accessible over port 8080 (again, configured via the aforementioned `config.edn`).
|
||
|
|
The Swagger UI page will be available at `/api-docs/` e.g. http://localhost:8080/api-docs/
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Copyright © 2021 Gered King
|
||
|
|
|
||
|
|
Distributed under the the MIT License. See LICENSE for more details.
|