update README

This commit is contained in:
rmanach 2025-01-08 13:37:28 +01:00
parent 212ca7f957
commit c0e3bc69d4

View File

@ -1,3 +1,20 @@
# librapi # librapi
A simple server to store, search and download resources (books, articles, etc...). A simple server to store, search and download resources (books, articles, etc...).
Its uses an **sqlite3** database to register resources.
**NOTE**: The UI is dramatically ugly with almost no CSS and no responsiveness with small screens. There's no vocation to build a beautiful UI here, just to demonstrate how easy we can build practicable UI with server side rendering using Go std lib. Ideal for back office.
## Build
Build the binary `builds/librapi`:
```bash
make build
```
## Run
```bash
make run
```
You can then access the server through `http://localhost:8585`.
Enjoy !