ButterGarden/README.md

🧁 Butter Garden

A delightful recipe management application built with Flask, featuring a cozy, warm-toned interface and modern web technologies.

✨ Features

• 🔍 Browse and search recipes
• 📝 View detailed recipe ingredients and instructions
• 👤 Admin interface for managing recipes
• 🎨 Beautiful, responsive design with custom styling
• 🚀 Modern interactions using HTMX
• 🌙 Warm, inviting color scheme
• 🐳 Docker support for easy deployment

🛠️ Technology Stack

• Backend: Flask + SQLAlchemy
• Frontend: HTMX + Custom CSS
• Database: SQLite
• Authentication: Flask-Login
• Styling: CSS Variables + Modern CSS Features
• Deployment: Docker + Gunicorn

🚀 Quick Start with Docker

The easiest way to run Butter Garden is using Docker:

1. Clone the repository:

   git clone https://github.com/HardwarePunk/ButterGarden.git
   cd ButterGarden
   

2. Set up environment variables:

   cp .env.example .env
   # Edit .env with your preferred settings
   

3. Start with Docker Compose:

   docker-compose up -d
   

That's it! Visit http://localhost:5000 to start using Butter Garden.

🐳 Docker Details

Container Features

• Production-grade Gunicorn server
• Automatic health checks
• Persistent SQLite database volume
• Non-root user for security
• Automatic restarts on failure

Container Management

Start the container:

docker-compose up -d

View logs:

docker-compose logs -f

Stop the container:

docker-compose down

Rebuild after changes:

docker-compose up -d --build

Docker Configuration

• Port: 5000 (configurable in docker-compose.yml)
• Database location: /app/instance (mounted as volume)
• Environment variables: loaded from .env file
• Health check interval: 30 seconds

📝 Manual Installation (Without Docker)

If you prefer to run without Docker:

1. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Set up environment variables:

   cp .env.example .env
   # Edit .env with your preferred settings
   

4. Initialize the database:

   python init_db.py
   

5. Run the development server:

   flask run
   

🔒 Environment Variables

Required variables in .env:

FLASK_SECRET_KEY=your-secret-key-here
ADMIN_USERNAME=your-admin-username
ADMIN_PASSWORD=your-secure-password
FLASK_ENV=production  # or development

👩‍💻 Development

The application uses modern CSS features and HTMX for enhanced interactivity:

• CSS Variables for easy theme customization
• Responsive design, mobile friendly
• HTMX for dynamic content updates
• Custom scrollbar styling
• Sticky navigation elements

🎨 Customization

The app's appearance can be easily customized by modifying the CSS variables in static/css/main.css:

:root {
  --primary-color: #9B4819;     /* Warm terracotta */
  --secondary-color: #D68C45;   /* Muted orange */
  --background-color: #FDF6EC;  /* Warm off-white */
  /* ... other variables ... */
}

📱 Responsive Design

• Desktop: Left sidebar navigation
• Mobile: Top navigation bar
• Adaptive recipe content display
• Optimized spacing and typography

🤝 Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feature-name
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin feature-name
5. Submit a pull request

📝 License

This project is licensed under the Unlicense License - see the LICENSE file for details.