HostelHive documentation

How to install HostelHive, run it for a hostel, and wire up the QR gate scanners. If this is your first time, start with the quick start.

Install and deploy

• What HostelHive is

  The four repositories and what each one does.

• Backend

  Go API, PostgreSQL, Firebase sign-in and migrations.

• Web dashboard

  The staff dashboard and student portal, hosted on Vercel.

• Mobile app

  The Flutter app students carry their QR pass in.

• Gate scanners

  ESP32 firmware, wiring and setting up a gate.

Run a hostel

• Roles and permissions

  Who can see and change what.

• Adding students

  Email invitations, one at a time or from a spreadsheet.

• Movement policy

  Open hours, late-access requests and Going Home.

• Attendance

  How a scan becomes IN or OUT on the dashboard.

• Complaints

  From a student’s report to a resolved ticket.

• Reports

  Attendance and complaint history, as PDF or Excel.