docs: Add minimal README
This commit is contained in:
1 parent
cec7f1566e
commit
17c511f973
1 file changed
+39
@@ -0,0 +1,39 @@
|
||||
# prayertimes
|
||||
|
||||
Prayer times and location search backed by Diyanet data, with an
|
||||
astronomical-calculation fallback when the upstream API is unavailable.
|
||||
|
||||
## Running
|
||||
|
||||
```bash
|
||||
go run .
|
||||
```
|
||||
|
||||
Or via Docker (the image ships with a preseeded GeoNames cities database,
|
||||
no extra setup needed):
|
||||
|
||||
```bash
|
||||
docker build -t prayertimes .
|
||||
docker run -p 8000:8000 prayertimes
|
||||
```
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Variable | Default | Description |
|
||||
|-----------|-------------------------------|-----------------------|
|
||||
| `PORT` | `8000` | HTTP listen port |
|
||||
| `DB_PATH` | `./prayertimes.sqlite3` | Path to the cities DB |
|
||||
|
||||
## API
|
||||
|
||||
Interactive API docs (Swagger UI) are served at `/api`, covering the
|
||||
current `/api/v1/*` endpoints. Older `/api/diyanet/*` endpoints are
|
||||
deprecated and intentionally left out of the docs.
|
||||
|
||||
## Development
|
||||
|
||||
Refresh the cities database from GeoNames:
|
||||
|
||||
```bash
|
||||
python3 scripts/seed_cities.py --db ./prayertimes.sqlite3
|
||||
```
|
||||
Reference in new issue
Block a user