From dc1e3a62a1bfe1de17cefa685570e56ddd7164da Mon Sep 17 00:00:00 2001 From: Decobus Date: Sat, 19 Jul 2025 05:32:07 -0400 Subject: [PATCH] Add comprehensive database setup instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Document both quick start and custom database location options - Explain template database usage and git ignore behavior - Provide clear steps for FILE_DIRECTORY environment variable setup - Help users avoid accidentally committing personal development data 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5169f28..9e47f56 100644 --- a/README.md +++ b/README.md @@ -61,11 +61,26 @@ Without an API key, anyone on your network can control your OBS streams. ### Database Setup +The project includes an empty template database for easy setup: + ```bash -# Create seasonal database tables +# Option 1: Use template database directly (development) +# Database will be created in ./files/sources.db +npm run create-sat-summer-2025-tables + +# Option 2: Set up custom database location (recommended) +# 1. Copy the template database +cp files/sources.template.db /path/to/your/database/sources.db + +# 2. Set environment variable in .env.local +echo "FILE_DIRECTORY=/path/to/your/database" >> .env.local + +# 3. Create tables in your custom database npm run create-sat-summer-2025-tables ``` +**Template Database**: The repository includes `files/sources.template.db` with the proper schema but no data. Your local development database (`sources.db`) is automatically ignored by git to prevent committing personal data. + ## Development Commands ```bash