docs: setup proper documentation, organize & clean README

This commit is contained in:
2025-09-13 15:27:32 -05:00
parent 94fb6b4190
commit 878cc5f773
7 changed files with 254 additions and 123 deletions

View File

@@ -1,21 +1,28 @@
default_services := "bot,web,scraper"
# Auto-reloading frontend server
frontend:
pnpm run -C web dev
backend:
cargo run --bin banner
# Production build of frontend
build-frontend:
pnpm run -C web build
build-backend:
cargo build --release --bin banner
# Auto-reloading backend server
backend services=default_services:
bacon --headless run -- -- --services "{{services}}"
build: build-frontend build-backend
# Production build that embeds assets
build-prod:
# Production build
build:
pnpm run -C web build
cargo build --release --bin banner
# Run auto-reloading development build with release characteristics (frontend is embedded, non-auto-reloading)
# This is useful for testing backend release-mode details.
dev-build services=default_services: build-frontend
bacon --headless run -- --profile dev-release -- --services "{{services}}" --tracing pretty
# Auto-reloading development build for both frontend and backend
# Will not notice if either the frontend/backend crashes, but will generally be resistant to stopping on their own.
[parallel]
dev: frontend backend
dev services=default_services: frontend (backend services)