Просмотр исходного кода

dev: automated commit - 2026-03-08 11:06:25

Mariano Z. 2 недель назад
Родитель
Сommit
32eb49fb6c
1 измененных файлов с 10 добавлено и 1 удалено
  1. 10 1
      README.md

+ 10 - 1
README.md

@@ -6,7 +6,7 @@ Dynamic DNS updater for Cloudflare. Keeps your DNS records pointing at your curr
 
 Goflare runs a configurable cron job that periodically fetches your public IP from multiple providers (with fallback) and compares it against the DNS records you've configured. When a change is detected, it updates the records via the Cloudflare REST API.
 
-You manage your Cloudflare zones and DNS records through a web UI. Records can be marked as **static** to exclude them from automatic updates. The cron schedule is configurable at runtime through the settings page.
+You manage your Cloudflare zones and DNS records through a web UI. Records can be marked as **static** to exclude them from automatic updates. The cron schedule and the list of IP lookup providers (with fallback) are configurable at runtime in **Settings**.
 
 ### Stack
 
@@ -14,6 +14,8 @@ You manage your Cloudflare zones and DNS records through a web UI. Records can b
 - **Frontend:** Vue 3 SPA with Tailwind CSS and shadcn-vue components.
 - **Single binary** that serves both the API and the frontend.
 
+On first run, open the app in your browser and create your account (setup page); after that you log in as usual.
+
 ## Docker
 
 ### Build
@@ -52,3 +54,10 @@ services:
     environment:
       - GOFLARE_SESSION_SECRET=changeme
 ```
+
+## Local development
+
+- `just run` — build (sqlc + frontend + go) and run the server (serves API and frontend from `bin/goflare`).
+- `just frontend-dev` — run the Vite dev server with API proxy to the Go backend (run the backend separately, e.g. `go run ./cmd/goflare`).
+- `just gen` — regenerate sqlc only (after changing `sql/schema/` or `sql/queries/`).
+- `just clean` — remove `bin/` and `frontend/dist/`.