chore: initialize repo with comprehensive .gitignore and README skeleton
Establishes the FabledRulebook-required ignore patterns (docs/superpowers/specs, docs/superpowers/plans) plus Python/Node/Vite/extension/volumes/IDE rules from spec §6.1 before any other code lands, so accidental adds can't leak. Also ignores .claude/settings.local.json (per-user local overrides; shared .claude/settings.json may be committed in the future). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
+67
@@ -0,0 +1,67 @@
|
||||
# FabledRulebook-required (agent-authored specs/plans live local only)
|
||||
docs/superpowers/specs/
|
||||
docs/superpowers/plans/
|
||||
|
||||
# Secrets and environment
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
*.secret
|
||||
*.key
|
||||
*.pem
|
||||
|
||||
# Python
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
.pytest_cache/
|
||||
.mypy_cache/
|
||||
.ruff_cache/
|
||||
.coverage
|
||||
.coverage.*
|
||||
htmlcov/
|
||||
.tox/
|
||||
*.egg-info/
|
||||
build/
|
||||
dist/
|
||||
venv/
|
||||
.venv/
|
||||
|
||||
# Node / Vue / Vite
|
||||
frontend/node_modules/
|
||||
frontend/dist/
|
||||
frontend/.vite/
|
||||
frontend/coverage/
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
.pnpm-debug.log
|
||||
|
||||
# Firefox extension build artifacts (lands in FC-3)
|
||||
extension/*.xpi
|
||||
extension/web-ext-artifacts/
|
||||
|
||||
# Runtime volumes (must never be tracked)
|
||||
images/
|
||||
import/
|
||||
downloads/
|
||||
models/
|
||||
postgres_data/
|
||||
redis_data/
|
||||
|
||||
# IDE / OS
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# Claude Code per-user local overrides (shared .claude/settings.json is OK to commit)
|
||||
.claude/settings.local.json
|
||||
|
||||
# Alembic / DB scratch
|
||||
alembic/versions/__pycache__/
|
||||
*.sqlite
|
||||
*.sqlite-journal
|
||||
@@ -0,0 +1,26 @@
|
||||
# FabledCurator
|
||||
|
||||
Self-hosted media curation — gallery, ML tagging, and subscription-driven downloading in one app. Part of the FabledSword family.
|
||||
|
||||
Combines what was [ImageRepo](https://git.fabledsword.com/bvandeusen/ImageRepo) (gallery, ML, importer) and [GallerySubscriber](https://git.fabledsword.com/bvandeusen/GallerySubscriber) (gallery-dl wrapper, subscriptions, credential capture) into a single product.
|
||||
|
||||
## Status
|
||||
|
||||
Pre-v1. Not yet functional.
|
||||
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
# edit .env: set DB_PASSWORD and SECRET_KEY
|
||||
docker compose up -d
|
||||
# UI: http://localhost:8080
|
||||
```
|
||||
|
||||
## Deployment posture
|
||||
|
||||
FabledCurator is designed to run inside a self-hosted homelab environment over plain HTTP. If you want TLS, terminate it at your reverse proxy. The app does not generate certificates, redirect to HTTPS, or set HSTS.
|
||||
|
||||
## License
|
||||
|
||||
Personal project; use at your own discretion.
|
||||
Reference in New Issue
Block a user