add docker containerization

README.md

@@ -10,6 +10,7 @@ A delightful recipe management application built with Flask, featuring a cozy, w
 - 🎨 Beautiful, responsive design with custom styling
 - 🚀 Modern interactions using HTMX
 - 🌙 Warm, inviting color scheme
+- 🐳 Docker support for easy deployment
 
 ## 🛠️ Technology Stack
 
@@ -18,8 +19,11 @@ A delightful recipe management application built with Flask, featuring a cozy, w
 - **Database**: SQLite
 - **Authentication**: Flask-Login
 - **Styling**: CSS Variables + Modern CSS Features
+- **Deployment**: Docker + Gunicorn
 
-## 🚀 Getting Started
+## 🚀 Quick Start with Docker
+
+The easiest way to run Butter Garden is using Docker:
 
 1. Clone the repository:
    ```bash
@@ -27,49 +31,100 @@ A delightful recipe management application built with Flask, featuring a cozy, w
    cd ButterGarden
    ```
 
-2. Create and activate a virtual environment:
-   ```bash
-   python -m venv venv
-   source venv/bin/activate  # On Windows: venv\Scripts\activate
-   ```
-
-3. Install dependencies:
-   ```bash
-   pip install -r requirements.txt
-   ```
-
-4. Set up your environment variables:
+2. Set up environment variables:
    ```bash
    cp .env.example .env
    # Edit .env with your preferred settings
    ```
 
-5. Initialize the database:
+3. Start with Docker Compose:
+   ```bash
+   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:**
+```bash
+docker-compose up -d
+```
+
+**View logs:**
+```bash
+docker-compose logs -f
+```
+
+**Stop the container:**
+```bash
+docker-compose down
+```
+
+**Rebuild after changes:**
+```bash
+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:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+2. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. Set up environment variables:
+   ```bash
+   cp .env.example .env
+   # Edit .env with your preferred settings
+   ```
+
+4. Initialize the database:
    ```bash
    python init_db.py
    ```
 
-6. Run the application:
+5. Run the development server:
    ```bash
    flask run
    ```
 
-Visit `http://localhost:5000` to start using Butter Garden!
-
 ## 🔒 Environment Variables
 
-Create a `.env` file with the following variables:
-```
+Required variables in `.env`:
+```bash
 FLASK_SECRET_KEY=your-secret-key-here
 ADMIN_USERNAME=your-admin-username
 ADMIN_PASSWORD=your-secure-password
-FLASK_ENV=development
+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