Skip to main content

Quick Start Wizard

Welcome to Hive-Pal! This interactive guide will help you get up and running in minutes. Follow these steps to set up your beekeeping management system.

Prerequisites​

Before you begin, ensure you have:

  • Docker and Docker Compose installed (for Docker setup)
  • Node.js 18+ and PostgreSQL (for manual setup)
  • A modern web browser

Step 1: Choose Your Installation Method​

Docker Installation​

The fastest way to get started with Hive-Pal.

# Clone the repository
git clone https://github.com/martinhrvn/hive-pal.git
cd hive-pal

# Copy environment files
cp apps/backend/.env.example apps/backend/.env
cp apps/frontend/.env.example apps/frontend/.env

# Start the application
docker-compose up -d
tip

Docker Compose will automatically:

  • Set up PostgreSQL database
  • Run database migrations
  • Start the backend API
  • Start the frontend application

Step 2: Access the Application​

Once the installation is complete:

  1. Open your browser and navigate to http://localhost:5173
  2. You should see the Hive-Pal landing page
note
  • Frontend runs on port 5173
  • Backend API runs on port 3000
  • API documentation available at http://localhost:3000/api-docs

Step 3: Create Your Account​

[Video: Account Registration Process - Coming Soon]

  1. Click "Get Started" on the landing page
  2. Choose "Sign Up" to create a new account
  3. Enter your details:
    • Email address
    • Password (minimum 8 characters)
    • Confirm password
  4. Click "Create Account"

Step 4: Initial Setup Wizard​

When you first log into Hive-Pal, you'll be automatically guided through a setup wizard that helps you create your first apiary and hive.

The Setup Process​

The wizard consists of four steps:

Step 1: Welcome Screen​

  • Introduction to Hive-Pal
  • Overview of what you'll set up
  • Click "Get Started" to begin

Step 2: Create Your First Apiary​

  • Apiary Name: Enter a descriptive name (e.g., "Home Garden", "Smith Farm")
  • Location: Add address or description
  • GPS Coordinates (optional): For weather integration
  • Notes (optional): Any additional information
  • The apiary is created immediately upon submission

Step 3: Add Your First Hive​

  • Hive Name/Identifier: Choose a unique name or number
  • Hive Type: Select from available options
  • Status: Set initial status (Active, Preparing, etc.)
  • Installation Date: When the hive was set up
  • The hive is automatically assigned to the apiary you just created

Step 4: Setup Complete​

  • Confirmation that your initial setup is finished
  • Click "Go to Dashboard" to start using Hive-Pal
  • You now have your first apiary with one hive ready to track!

Step 5: Explore Key Features​

Quick Actions Menu (FAB)​

The floating action button (FAB) in the bottom right corner provides quick access to three primary actions:

  • Add Inspection (Blue): Record a new hive inspection
  • Schedule Inspection (Purple): Plan future inspections
  • Add Actions (Green): Record treatments, feeding, or other management actions across multiple hives

Dashboard Overview​

Your dashboard displays:

  • Recent inspections
  • Upcoming scheduled tasks
  • Weather forecast for your apiaries
  • Quick statistics

Mobile Usage​

Hive-Pal is fully responsive and works great on mobile devices:

  • Record inspections in the field
  • Quick access to hive history
  • Offline capability (data syncs when reconnected)

What's Next?​

Now that you're set up, explore these features:

Need Help?​

Video Tutorial​

[Complete Video Walkthrough - Coming Soon]

Congratulations!

You've successfully set up Hive-Pal and are ready to manage your apiaries digitally. Happy beekeeping! 🐝