{"id":42719085,"url":"https://github.com/martinhrvn/hive-pal","last_synced_at":"2026-02-25T15:17:04.738Z","repository":{"id":266910836,"uuid":"899738749","full_name":"martinhrvn/hive-pal","owner":"martinhrvn","description":"A comprehensive mobile-first beekeeping management application to track hives, inspections, and colony health.","archived":false,"fork":false,"pushed_at":"2026-01-21T17:56:05.000Z","size":47327,"stargazers_count":15,"open_issues_count":10,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-01-22T05:36:22.770Z","etag":null,"topics":["beekeeping"],"latest_commit_sha":null,"homepage":"https://hivepal.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/martinhrvn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-12-06T22:50:02.000Z","updated_at":"2026-01-21T17:56:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"b4fa040a-8e42-48d9-ae32-eb60093d393f","html_url":"https://github.com/martinhrvn/hive-pal","commit_stats":null,"previous_names":["martinhrvn/hive-pal"],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/martinhrvn/hive-pal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinhrvn%2Fhive-pal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinhrvn%2Fhive-pal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinhrvn%2Fhive-pal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinhrvn%2Fhive-pal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/martinhrvn","download_url":"https://codeload.github.com/martinhrvn/hive-pal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinhrvn%2Fhive-pal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28880851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T10:31:27.438Z","status":"ssl_error","status_checked_at":"2026-01-29T10:31:01.017Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beekeeping"],"created_at":"2026-01-29T16:03:30.526Z","updated_at":"2026-01-29T16:04:40.845Z","avatar_url":"https://github.com/martinhrvn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hive Pal 🐝\n\n[![Tests](https://github.com/martinhrvn/hive-pal/actions/workflows/check.yml/badge.svg)](https://github.com/martinhrvn/hive-pal/actions/workflows/check.yml)\n\nA modern beekeeping management application designed for both mobile and desktop use. Track your apiaries, hives, inspections, and more with our intuitive interface.\n\n**⚠️ IMPORTANT: This project is very much a Work In Progress. The API is mostly stable but there may be breaking changes.**\n\n## Features\n\n- **Apiary Management**: Create and track multiple apiaries with location information\n- **Hive Tracking**: Monitor hives, their status, and configuration\n- **Inspection Workflows**: Record detailed inspections with observations and actions\n- **Queen Management**: Track queen lineage and replacement history\n- **Mobile-First Design**: Optimized for field use with easy data entry\n\n## Getting Started\n\n### Prerequisites\n\n- Docker and Docker Compose\n- Node.js 18+ (for development only)\n- PNPM package manager\n\n### Running with Docker Compose (Production)\n\nThe application includes a production-ready Docker Compose configuration that sets up all required services.\n\n```bash\n# Clone the repository (or download docker-compose.prod.yaml)\ngit clone https://github.com/martinhrvn/hive-pal.git\ncd hive-pal\n\n# Create a .env file with your configuration (see Environment Variables below)\ncp .env.example .env\n\n# Start all services (backend, frontend, database)\ndocker-compose -f docker-compose.prod.yaml up -d\n\n# View logs\ndocker-compose -f docker-compose.prod.yaml logs -f\n\n# Stop all services\ndocker-compose -f docker-compose.prod.yaml down\n\n# Stop and remove volumes (WARNING: deletes all data)\ndocker-compose -f docker-compose.prod.yaml down -v\n```\n\nThe application will be available at:\n- Frontend: http://localhost (port 80)\n- Backend API: http://localhost:3000\n- API Documentation: http://localhost:3000/api-docs\n\n### Production Deployment with Traefik (Recommended)\n\nFor production deployments with SSL/TLS, use the Traefik configuration:\n\n```bash\n# Set your domain and email for Let's Encrypt\nexport DOMAIN=yourdomain.com\nexport ACME_EMAIL=admin@yourdomain.com\n\n# Start with Traefik reverse proxy\ndocker-compose -f docker-compose.traefik.yaml up -d\n```\n\nThis provides:\n- Automatic HTTPS with Let's Encrypt certificates\n- Frontend at `https://yourdomain.com`\n- Backend API at `https://api.yourdomain.com`\n- Automatic HTTP to HTTPS redirect\n\nRequired DNS records:\n- `yourdomain.com` → your server IP\n- `api.yourdomain.com` → your server IP\n\n### Environment Variables\n\nCreate a `.env` file in the project root with the following variables:\n\n#### Required Variables\n\n```bash\n# Backend Configuration\nDATABASE_URL=postgres://postgres:postgres@postgres:5432/beekeeper\nADMIN_EMAIL=admin@example.com           # Initial admin account email\nADMIN_PASSWORD=changeme123              # Initial admin account password (change this!)\nAPI_URL=http://backend:3000             # Internal API URL for frontend\nFRONTEND_URL=https://yourdomain.com     # Public frontend URL (for emails)\n\n# Frontend Configuration\nVITE_API_URL=https://api.yourdomain.com # Public API URL for browser\n```\n\n#### Optional Variables\n\n```bash\n# Email Configuration (Optional - required for password reset functionality)\nSMTP_HOST=smtp.gmail.com                # SMTP server hostname\nSMTP_PORT=587                           # SMTP server port\nSMTP_USER=your-email@gmail.com          # SMTP username\nSMTP_PASS=your-app-password             # SMTP password\nSMTP_SECURE=false                       # Use TLS (true for port 465, false for 587)\nSMTP_REJECT_UNAUTHORIZED=false          # Reject self-signed certificates\nFROM_EMAIL=noreply@yourdomain.com       # Sender email address\n\n# Monitoring (Optional - for error tracking)\nSENTRY_DSN=https://your-sentry-dsn      # Backend Sentry DSN\nSENTRY_ENVIRONMENT=production            # Environment name\nVITE_SENTRY_DSN=https://frontend-dsn    # Frontend Sentry DSN\nVITE_SENTRY_ENVIRONMENT=production      # Frontend environment\n```\n\n### Docker Compose Services\n\nThe `docker-compose.prod.yaml` file sets up three services:\n\n1. **PostgreSQL Database**\n   - Image: `postgres:14`\n   - Persistent data storage at `/data/hive-pal-data/postgres`\n   - Health checks ensure database readiness\n\n2. **Backend (NestJS)**\n   - Image: `ghcr.io/martinhrvn/hive-pal-backend:latest`\n   - Depends on PostgreSQL\n   - Health endpoint: `/api/health`\n   - Handles API requests and business logic\n   - **Automatic migrations**: Database migrations run automatically on startup\n\n3. **Frontend (React)**\n   - Image: `ghcr.io/martinhrvn/hive-pal-frontend:latest`\n   - Depends on Backend\n   - Serves the web interface\n   - Connects to backend via configured API URL\n\n## Development\n\n```bash\n# Clone the repository\ngit clone https://github.com/martinhrvn/hive-pal.git\n\n# Install dependencies\ncd hive-pal\npnpm install\n\n# Start the development server\npnpm dev\n```\n\n## Project Structure\n\n```\n/apps\n  /frontend - React frontend application\n  /backend - NestJS API server\n  /e2e - End-to-end tests with Playwright\n/packages\n  /shared-schemas - Shared Zod validation schemas\n  /page-objects - Page objects for E2E testing\n```\n\n## Technology Stack\n\n### Frontend\n- **Framework**: React 19 with TypeScript\n- **Styling**: Tailwind CSS v4\n- **UI Components**: shadcn/ui\n- **State Management**: Zustand + React Query (TanStack Query)\n- **Routing**: React Router\n- **Build Tool**: Vite\n- **Form Handling**: React Hook Form with Zod validation\n\n### Backend\n- **Framework**: NestJS with TypeScript\n- **Database**: PostgreSQL 14\n- **ORM**: Prisma\n- **Authentication**: JWT with refresh tokens\n- **API Documentation**: Swagger/OpenAPI\n- **Logging**: Winston with Loki integration\n- **Monitoring**: Prometheus metrics, health checks\n\n### DevOps \u0026 Tooling\n- **Package Management**: PNPM with workspaces\n- **Build System**: Turborepo for monorepo management\n- **Containerization**: Docker with multi-stage builds\n- **Testing**: Jest, Playwright, Testcontainers\n- **CI/CD**: GitHub Actions\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Acknowledgments\n\n- Inspired by beekeepers who needed a better way to track their hives\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartinhrvn%2Fhive-pal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmartinhrvn%2Fhive-pal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartinhrvn%2Fhive-pal/lists"}