add .env.example, user-stories.md

This commit is contained in:
Dylan Knutson
2025-08-27 19:12:40 +00:00
parent 947092ce54
commit 30751181e4
24 changed files with 4191 additions and 4 deletions

52
.env.example Normal file
View File

@@ -0,0 +1,52 @@
# ==================================
# Pawctioneer Bot Configuration
# ==================================
# Copy this file to .env and fill in your values
# Usage: cp .env.example .env
# ==== REQUIRED SETTINGS ====
# Your Telegram bot token from @BotFather
# Get one by messaging @BotFather on Telegram and creating a new bot
TELOXIDE_TOKEN=your_bot_token_here
# ==== OPTIONAL SETTINGS ====
# Database file location (SQLite)
# Default: sqlite:pawctioneer_bot.db
# You can use an absolute path: /path/to/your/database.db
DATABASE_URL=sqlite:pawctioneer_bot.db
# Your Telegram user ID for admin commands
# You can get this by messaging @userinfobot on Telegram
# Uncomment and set your user ID to enable admin features
# ADMIN_USER_ID=123456789
# Port for the web admin interface (future feature)
# Default: 3000
WEB_PORT=3000
# ==== LOGGING SETTINGS ====
# Logging level configuration
# Options: error, warn, info, debug, trace
# You can set different levels for different modules:
# Examples:
# RUST_LOG=info # All modules at info level
# RUST_LOG=debug # All modules at debug level
# RUST_LOG=info,pawctioneer_bot=debug # Most modules info, this bot debug
# RUST_LOG=warn,teloxide=info # Most modules warn, teloxide info
RUST_LOG=info
# Timezone (optional, uses system timezone if not set)
# Examples: UTC, America/New_York, Europe/London, Asia/Tokyo
# TZ=UTC
# ==== DEVELOPMENT SETTINGS ====
# These settings are primarily for development and testing
# Enable more verbose teloxide logging (uncomment for debugging)
# RUST_LOG=debug,teloxide=debug
# Database with more detailed logging (uncomment for SQL debugging)
# RUST_LOG=debug,sqlx=debug