Laurenz/Laterna
1
0
Fork 0
mirror of https://github.com/kaaninchen/Laterna.git synced 2026-09-17 19:12:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve README

Browse Source
This commit is contained in:
Siesta
2025-07-28 21:08:34 +02:00
parent cc317ca661
commit f0bc335f0d
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+25
View File
@@ -1,13 +1,38 @@
# 🛋️ Laterna (Server) # 🛋️ Laterna (Server)
Laterna is an lightweight REST api for sharing HEX color codes between 2 (or more) lamps with simple HTTP requests, written in go.
> [!NOTE]
> This project was developed with my own use case in mind.
> This is also my first REST api and my first project in go, so expect bugs and weird annoyances/limitations.
## 🏵️ Setup ## 🏵️ Setup
### 1. Clone the repository
```sh
git clone https://github.com/siestaw/laterna.git
cd laterna
```
### 2. Configure the server
Laterna requires a config.json in it's root directory. An [example config](https://github.com/siestaw/Laterna/blob/main/config.json.example) is provided Laterna requires a config.json in it's root directory. An [example config](https://github.com/siestaw/Laterna/blob/main/config.json.example) is provided
`$ mv config.json.example config.json` `$ mv config.json.example config.json`
You can leave the json as it is or configure it to your liking, although some configuration options (e.g. `verboseLogging`) aren't fully implemented yet. You can leave the json as it is or configure it to your liking, although some configuration options (e.g. `verboseLogging`) aren't fully implemented yet.
### 3. Run
Make sure that go is installed. The server was tested with go 1.24.5 on linux.
`$ go run ./cmd/server`
or use the makefile:
`$ make run`
## 🛜 API Documentation ## 🛜 API Documentation
### Base URL ### Base URL