Add comprehensive database setup instructions
- 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 <noreply@anthropic.com>
This commit is contained in:
parent
0d9c88958e
commit
dc1e3a62a1
1 changed files with 16 additions and 1 deletions
17
README.md
17
README.md
|
@ -61,11 +61,26 @@ Without an API key, anyone on your network can control your OBS streams.
|
||||||
|
|
||||||
### Database Setup
|
### Database Setup
|
||||||
|
|
||||||
|
The project includes an empty template database for easy setup:
|
||||||
|
|
||||||
```bash
|
```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
|
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
|
## Development Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue