Hive-Pal
Community-Supported Agriculture (CSA)
About this project
Hive Pal 🐝
A modern beekeeping management application designed for both mobile and desktop use. Track your apiaries, hives, inspections, and more with our intuitive interface.
⚠️ IMPORTANT: This project is very much a Work In Progress. The API is mostly stable but there may be breaking changes.
Features
- Apiary Management: Create and track multiple apiaries with location information
- Hive Tracking: Monitor hives, their status, and configuration
- Inspection Workflows: Record detailed inspections with observations and actions
- Queen Management: Track queen lineage and replacement history
- Mobile-First Design: Optimized for field use with easy data entry
Getting Started
The default docker-compose.prod.yaml
doesn't expose ports directly for security. To access the services:
Option 1: Add port mappings (create docker-compose.override.yaml
):
services:
frontend:
ports:
- "80:9000" # Expose frontend on port 80
backend:
ports:
- "3000:3000" # Expose backend API on port 3000
Option 2: Use a reverse proxy (recommended for production) - Configure nginx/Caddy to proxy requests to the Docker services.
Environment Variables
Create a .env
file in the project root with the following variables:
Required Variables
# Backend Configuration
DATABASE_URL=postgres://postgres:postgres@postgres:5432/beekeeper
ADMIN_EMAIL=admin@example.com # Initial admin account email
ADMIN_PASSWORD=changeme123 # Initial admin account password (change this!)
API_URL=http://backend:3000 # Internal API URL for frontend
FRONTEND_URL=https://yourdomain.com # Public frontend URL (
Technologies & License
MIT
Node.js
Docker
Quick Deploy
Deploy this project to cloud platforms with one click