Skip to content

docs: refresh README landing page #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lan17 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: refresh README landing page #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2f4cc5
docs: refresh README landing page
lan17 May 18, 2026
56c080f
docs: humanize README tone
lan17 May 18, 2026
fed8005
Simplify local getting started
lan17 May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
SHELL := /bin/bash
.SHELLFLAGS := -eu -o pipefail -c

.PHONY: help up down docker-build docker-push run db test coverage typecheck lint lock-check check db-migrate db-migration publish ui-% fake-camera
.PHONY: help up down docker-build docker-push local local-setup run db test coverage typecheck lint lock-check check db-migrate db-migration publish ui-% fake-camera

help:
@echo "Targets:"
Expand All @@ -13,6 +13,8 @@ help:
@echo " make docker-push Push to DockerHub"
@echo ""
@echo " Local dev:"
@echo " make local Set up local config, build UI, start Postgres, and run HomeSec"
@echo " make local-setup Copy starter config and create local data directories"
@echo " make run Run HomeSec locally (requires Postgres)"
@echo " make db Start just Postgres"
@echo " make test Run tests with coverage"
Expand Down Expand Up @@ -62,6 +64,25 @@ docker-push: docker-build
docker push $(DOCKERHUB_USER)/$(DOCKER_IMAGE):latest

# Local dev
local: local-setup db ui-install ui-build run

local-setup:
@mkdir -p config recordings/inbox storage backups/postgres
@if [ ! -f .env ]; then \
cp .env.example .env; \
echo "Created .env from .env.example"; \
else \
echo ".env already exists; leaving it unchanged"; \
fi
@if [ ! -f "$(HOMESEC_CONFIG)" ]; then \
cp config/local.yaml "$(HOMESEC_CONFIG)"; \
chmod 600 "$(HOMESEC_CONFIG)"; \
echo "Created $(HOMESEC_CONFIG) from config/local.yaml"; \
else \
echo "$(HOMESEC_CONFIG) already exists; leaving it unchanged"; \
fi
@echo "Local setup ready. Add clips to recordings/inbox or edit $(HOMESEC_CONFIG) for real cameras."

run:
@echo "Running database migrations..."
@$(UV_RUN) alembic -c alembic.ini upgrade head
Expand Down
Loading
Loading