dish-planner/app
1
0
Fork 0
Code Issues 9 Pull requests Projects Releases Packages Wiki Activity Actions

Update prod and dev instructions

Browse source
This commit is contained in:
myrmidex 2026-01-08 21:40:19 +01:00
parent 1de78bdce3
commit ea6f7ebf29
2 changed files with 88 additions and 378 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

123
Makefile
View file

@ -1,123 +0,0 @@
# Dish Planner - Docker Commands
.PHONY: help
help: ## Show this help message
@echo "Dish Planner - Docker Management"
@echo ""
@echo "Usage: make [command]"
@echo ""
@echo "Available commands:"
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " %-20s %s\n", $$1, $$2}'
# Development Commands
.PHONY: dev
dev: ## Start development environment
docker compose up -d
@echo "Development server running at http://localhost:8000"
@echo "Mailhog available at http://localhost:8025"
.PHONY: dev-build
dev-build: ## Build and start development environment
docker compose build
docker compose up -d
.PHONY: dev-stop
dev-stop: ## Stop development environment
docker compose down
.PHONY: dev-clean
dev-clean: ## Stop and remove volumes (CAUTION: removes database)
docker compose down -v
.PHONY: logs
logs: ## Show application logs
docker compose logs -f app
.PHONY: logs-db
logs-db: ## Show database logs
docker compose logs -f db
# Production Commands
.PHONY: prod-build
prod-build: ## Build production image for Codeberg
./bin/build-push.sh
.PHONY: prod-build-tag
prod-build-tag: ## Build with specific tag (usage: make prod-build-tag TAG=v1.0.0)
./bin/build-push.sh $(TAG)
.PHONY: prod-login
prod-login: ## Login to Codeberg registry
podman login codeberg.org
# Laravel Commands
.PHONY: artisan
artisan: ## Run artisan command (usage: make artisan cmd="migrate")
docker compose exec app php artisan $(cmd)
.PHONY: composer
composer: ## Run composer command (usage: make composer cmd="require package")
docker compose exec app composer $(cmd)
.PHONY: npm
npm: ## Run npm command (usage: make npm cmd="install package")
docker compose exec app npm $(cmd)
.PHONY: migrate
migrate: ## Run database migrations
docker compose exec app php artisan migrate
.PHONY: seed
seed: ## Seed the database
docker compose exec app php artisan db:seed
.PHONY: fresh
fresh: ## Fresh migrate and seed
docker compose exec app php artisan migrate:fresh --seed
.PHONY: tinker
tinker: ## Start Laravel tinker
docker compose exec app php artisan tinker
.PHONY: test
test: ## Run tests
docker compose exec app php artisan test
# Utility Commands
.PHONY: shell
shell: ## Enter app container shell
docker compose exec app sh
.PHONY: db-shell
db-shell: ## Enter database shell
docker compose exec db mariadb -u dishplanner -pdishplanner dishplanner
.PHONY: clear
clear: ## Clear all Laravel caches
docker compose exec app php artisan cache:clear
docker compose exec app php artisan config:clear
docker compose exec app php artisan route:clear
docker compose exec app php artisan view:clear
.PHONY: optimize
optimize: ## Optimize Laravel for production
docker compose exec app php artisan config:cache
docker compose exec app php artisan route:cache
docker compose exec app php artisan view:cache
docker compose exec app php artisan livewire:discover
# Installation
.PHONY: install
install: ## First time setup
@echo "Setting up Dish Planner..."
@cp -n .env.example .env || true
@echo "Generating application key..."
@docker compose build
@docker compose up -d
@sleep 5
@docker compose exec app php artisan key:generate
@docker compose exec app php artisan migrate
@echo ""
@echo "✅ Installation complete!"
@echo "Access the app at: http://localhost:8000"
@echo "Create your first planner and user to get started."

343
README.md
View file

@ -11,285 +11,118 @@ ## ✨ Features
- **Dark theme UI** - Modern interface with purple/pink accents - **Dark theme UI** - Modern interface with purple/pink accents
- **Single container deployment** - Simplified hosting with FrankenPHP - **Single container deployment** - Simplified hosting with FrankenPHP
## 🚀 Quick Start ## 🚀 Self-hosting
### Prerequisites The production image is available at `codeberg.org/lvl0/dish-planner:latest`.
- Docker and Docker Compose
- Make (optional, for convenience commands)
### First Time Setup ### docker-compose.yml
```bash ```yaml
# Clone the repository services:
git clone https://github.com/yourusername/dish-planner.git app:
cd dish-planner image: codeberg.org/lvl0/dish-planner:latest
container_name: dishplanner_app
restart: always
ports:
- "8000:8000"
environment:
APP_KEY: "${APP_KEY}"
APP_URL: "${APP_URL}"
DB_DATABASE: "${DB_DATABASE}"
DB_USERNAME: "${DB_USERNAME}"
DB_PASSWORD: "${DB_PASSWORD}"
MAIL_HOST: "${MAIL_HOST:-}"
MAIL_PORT: "${MAIL_PORT:-587}"
MAIL_USERNAME: "${MAIL_USERNAME:-}"
MAIL_PASSWORD: "${MAIL_PASSWORD:-}"
MAIL_FROM_ADDRESS: "${MAIL_FROM_ADDRESS:-noreply@example.com}"
volumes:
- app_storage:/app/storage
depends_on:
- db
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:8000/up"]
interval: 30s
timeout: 10s
retries: 3
start_period: 40s
# Quick install with Make db:
make install image: mariadb:11
container_name: dishplanner_db
restart: always
environment:
MYSQL_DATABASE: "${DB_DATABASE}"
MYSQL_USER: "${DB_USERNAME}"
MYSQL_PASSWORD: "${DB_PASSWORD}"
MYSQL_ROOT_PASSWORD: "${DB_ROOT_PASSWORD}"
volumes:
- db_data:/var/lib/mysql
# Or manually: volumes:
cp .env.example .env db_data:
docker compose build app_storage:
docker compose up -d
docker compose exec app php artisan key:generate
docker compose exec app php artisan migrate
``` ```
The application will be available at **http://localhost:8000** ### Environment Variables
| Variable | Required | Description |
|----------|----------|-------------|
| `APP_KEY` | Yes | Encryption key. Generate with: `echo "base64:$(openssl rand -base64 32)"` |
| `APP_URL` | Yes | Your domain (e.g., `https://meals.example.com`) |
| `DB_DATABASE` | Yes | Database name |
| `DB_USERNAME` | Yes | Database user |
| `DB_PASSWORD` | Yes | Database password |
| `DB_ROOT_PASSWORD` | Yes | MariaDB root password |
| `MAIL_HOST` | No | SMTP host for email notifications |
| `MAIL_PORT` | No | SMTP port (default: 587) |
| `MAIL_USERNAME` | No | SMTP username |
| `MAIL_PASSWORD` | No | SMTP password |
| `MAIL_FROM_ADDRESS` | No | From address for emails |
## 🔧 Development ## 🔧 Development
### Starting the Development Environment ### NixOS / Nix
```bash ```bash
# Start all services git clone https://codeberg.org/lvl0/dish-planner.git
make dev cd dish-planner
nix-shell
# Or with Docker Compose directly
docker compose up -d
``` ```
**Available services:** The shell will display available commands and optionally start the containers for you.
- **App**: http://localhost:8000 (Laravel + FrankenPHP)
- **Vite**: http://localhost:5173 (Asset hot-reload)
- **Mailhog**: http://localhost:8025 (Email testing)
- **Database**: localhost:3306 (MariaDB)
### Common Development Commands #### Available Commands
```bash | Command | Description |
# View logs |---------|-------------|
make logs # App logs | `dev-up` | Start development environment |
make logs-db # Database logs | `dev-down` | Stop development environment |
| `dev-restart` | Restart containers |
| `dev-rebuild` | Full rebuild (removes volumes) |
| `dev-rebuild-quick` | Quick rebuild (keeps volumes) |
| `dev-logs [service]` | Follow logs |
| `dev-shell` | Enter app container |
| `dev-artisan <cmd>` | Run artisan commands |
| `dev-fix-permissions` | Fix Docker-created file permissions |
# Laravel commands #### Services
make artisan cmd="migrate" # Run artisan commands
make tinker # Start Laravel tinker
make test # Run tests
# Database | Service | URL |
make migrate # Run migrations |---------|-----|
make seed # Seed database | App | http://localhost:8000 |
make fresh # Fresh migrate with seeds | Vite | http://localhost:5173 |
| Mailhog | http://localhost:8025 |
| MariaDB | localhost:3306 |
# Testing ### Other Platforms
make test # Run tests
composer test:coverage-html # Run tests with coverage report (generates coverage/index.html)
# Utilities Contributions welcome for development setup instructions on other platforms.
make shell # Enter app container
make db-shell # Enter database shell
make clear # Clear all caches
```
### Project Structure
```
dish-planner/
├── app/
│ ├── Livewire/ # Livewire components
│ │ ├── Auth/ # Authentication
│ │ ├── Dishes/ # Dish management
│ │ ├── Schedule/ # Schedule calendar
│ │ └── Users/ # User management
│ └── Models/ # Eloquent models
├── resources/
│ └── views/
│ └── livewire/ # Livewire component views
├── docker-compose.yml # Development environment
├── docker-compose.prod.yml # Production environment
├── Dockerfile # Production image
├── Dockerfile.dev # Development image
└── Makefile # Convenience commands
```
## 🚢 Production Deployment
### Building for Production
```bash
# Build production image
make prod-build
# Start production environment
make prod
# Or with Docker Compose
docker compose -f docker-compose.prod.yml build
docker compose -f docker-compose.prod.yml up -d
```
### Production Environment Variables
Required environment variables for production:
```env
# Required - Generate APP_KEY (see instructions below)
APP_KEY=base64:your-generated-key-here
APP_URL=https://your-domain.com
# Database Configuration
DB_DATABASE=dishplanner
DB_USERNAME=dishplanner
DB_PASSWORD=strong-password-here
DB_ROOT_PASSWORD=strong-root-password
# Optional Email Configuration
MAIL_HOST=your-smtp-host
MAIL_PORT=587
MAIL_USERNAME=your-username
MAIL_PASSWORD=your-password
MAIL_FROM_ADDRESS=noreply@your-domain.com
```
#### Generating APP_KEY
The APP_KEY is critical for encryption and must be kept consistent across deployments. Generate one using any of these methods:
**Option 1: Using OpenSSL (Linux/Mac/Windows with Git Bash)**
```bash
echo "base64:$(openssl rand -base64 32)"
```
**Option 2: Using Node.js (Cross-platform)**
```bash
node -e "console.log('base64:' + require('crypto').randomBytes(32).toString('base64'))"
```
**Option 3: Using Python (Cross-platform)**
```bash
python -c "import base64, os; print('base64:' + base64.b64encode(os.urandom(32)).decode())"
```
**Option 4: Online Generator**
Generate a random 32-character string at https://randomkeygen.com/ and prepend with `base64:`
⚠️ **Important**: Save this key securely! If lost, you won't be able to decrypt existing data.
### Deployment with DockGE
The production setup is optimized for DockGE deployment with just 2 containers:
1. **app** - Laravel application with FrankenPHP
2. **db** - MariaDB database
Simply import the `docker-compose.prod.yml` into DockGE and configure your environment variables.
## 🛠️ Technology Stack
- **Backend**: Laravel 12 with Livewire 3
- **Web Server**: FrankenPHP (PHP 8.3 + Caddy)
- **Database**: MariaDB 11
- **Frontend**: Blade + Livewire + Alpine.js
- **Styling**: TailwindCSS with custom dark theme
- **Assets**: Vite for bundling
## 📦 Docker Architecture
### Development (`docker-compose.yml`)
- **Hot reload** - Volume mounts for live code editing
- **Debug tools** - Xdebug configured for debugging
- **Email testing** - Mailhog for capturing emails
- **Asset watching** - Vite dev server for instant updates
### Production (`docker-compose.prod.yml`)
- **Optimized** - Multi-stage builds with caching
- **Secure** - No debug tools, proper permissions
- **Health checks** - Automatic container monitoring
- **Single container** - FrankenPHP serves everything
## 🔨 Make Commands Reference
```bash
# Development
make dev # Start development environment
make dev-build # Build and start development
make dev-stop # Stop development environment
make dev-clean # Stop and remove volumes (CAUTION)
# Production
make prod # Start production environment
make prod-build # Build production image
make prod-stop # Stop production environment
make prod-logs # Show production logs
# Laravel
make artisan cmd="..." # Run artisan command
make composer cmd="..." # Run composer command
make npm cmd="..." # Run npm command
make migrate # Run migrations
make seed # Seed database
make fresh # Fresh migrate and seed
make tinker # Start tinker session
make test # Run tests
# Utilities
make shell # Enter app container
make db-shell # Enter database shell
make logs # Show app logs
make logs-db # Show database logs
make clear # Clear all caches
make optimize # Optimize for production
```
## 🐛 Troubleshooting
### Container won't start
```bash
# Check logs
docker compose logs app
# Rebuild containers
docker compose build --no-cache
docker compose up -d
```
### Database connection issues
```bash
# Verify database is running
docker compose ps
# Check database logs
docker compose logs db
# Try manual connection
make db-shell
```
### Permission issues
```bash
# Fix storage permissions
docker compose exec app chmod -R 777 storage bootstrap/cache
```
### Clear all caches
```bash
make clear
# Or manually
docker compose exec app php artisan cache:clear
docker compose exec app php artisan config:clear
docker compose exec app php artisan route:clear
docker compose exec app php artisan view:clear
```
## 📄 License ## 📄 License
This project is open-source software licensed under the [MIT license](LICENSE.md). This project is open-source software licensed under the [MIT license](LICENSE.md).
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 📞 Support ## 📞 Support
For issues and questions, please use the [GitHub Issues](https://github.com/yourusername/dish-planner/issues) page. For issues and questions, please use [Codeberg Issues](https://codeberg.org/lvl0/dish-planner/issues).
---
Built with ❤️ using Laravel and Livewire