⚡ Quick Start Guide

Get your first hotel property running in minutes

🎯 Overview

This guide will help you set up your first hotel property in Innkeeper and perform basic operations like creating rooms, managing reservations, and handling guests. By the end of this guide, you'll have a fully functional hotel management system.

Prerequisites: Complete the Installation Guide first.

🏨 Step 1: Create Your First Organization

After installation, you'll need to create an organization (the top-level entity in Innkeeper's multi-tenant architecture).

Using the Web Interface

Access the Application
```
http://localhost:3333
```
Register as Super Admin

Click "Get Started" or "Sign Up"
Fill in your details:
- Full Name: John Doe
- Email: [email protected]
- Username: admin
- Password: SecurePassword123!

Create Organization

Organization Name: Demo Hotels Group
Tax ID: 12345678901
Currency: USD
Timezone: America/New_York

Using CLI (Alternative)

# Create organization via command line
node ace make:organization \
  --name="Demo Hotels Group" \
  --slug="demo-hotels" \
  --email="[email protected]" \
  --currency="USD" \
  --timezone="America/New_York"

# Create admin user
node ace make:user \
  --name="John Doe" \
  --email="[email protected]" \
  --username="admin" \
  --password="SecurePassword123!" \
  --role="super_admin"

🏢 Step 2: Set Up Your First Hotel Property

Create Hotel Property

Navigate to Hotels

Go to Dashboard > Hotels > Add New Hotel

Basic Information

Hotel Name: Grand Plaza Hotel
Slug: grand-plaza
Description: A luxury hotel in the heart of the city
Email: [email protected]
Phone: +1 (555) 123-4567
Website: https://grandplaza.com

Location Details

Address: 123 Main Street
City: New York
State: NY
Country: United States
Postal Code: 10001

Hotel Settings

Star Rating: 4
Check-in Time: 15:00
Check-out Time: 11:00
Currency: USD
Timezone: America/New_York

Using API (Alternative)

# Create hotel via API
curl -X POST http://localhost:3333/api/hotels \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Grand Plaza Hotel",
    "slug": "grand-plaza",
    "description": "A luxury hotel in the heart of the city",
    "email": "[email protected]",
    "phone": "+1 (555) 123-4567",
    "address": "123 Main Street",
    "city": "New York",
    "state": "NY",
    "country": "United States",
    "postal_code": "10001",
    "star_rating": 4,
    "check_in_time": "15:00",
    "check_out_time": "11:00"
  }'

🛏️ Step 3: Create Room Types and Rooms

Create Room Types

Standard Room Type

Name: Standard King Room
Code: STD-KING
Description: Comfortable room with king-size bed
Max Occupancy: 2 adults
Base Price: $150.00
Size: 25 sqm
Bed Type: King
Bed Count: 1

Deluxe Room Type

Name: Deluxe Suite
Code: DLX-SUITE
Description: Spacious suite with separate living area
Max Occupancy: 4 adults
Base Price: $300.00
Size: 50 sqm
Bed Type: King + Sofa Bed
Bed Count: 1

Create Individual Rooms

Standard Rooms (Floor 1)

Room Numbers: 101, 102, 103, 104, 105
Room Type: Standard King Room
Floor: 1
Status: Available

Deluxe Suites (Floor 2)

Room Numbers: 201, 202, 203
Room Type: Deluxe Suite
Floor: 2
Status: Available

Bulk Room Creation (CLI)

# Create multiple rooms at once
node ace make:rooms \
  --hotel="grand-plaza" \
  --type="standard-king" \
  --floor="1" \
  --rooms="101,102,103,104,105"

node ace make:rooms \
  --hotel="grand-plaza" \
  --type="deluxe-suite" \
  --floor="2" \
  --rooms="201,202,203"

👥 Step 4: Add Hotel Staff

Create Staff Roles

Front Desk Manager

Name: Sarah Johnson
Email: [email protected]
Department: Front Office
Position: Front Desk Manager
Employee ID: EMP001

Housekeeping Supervisor

Name: Maria Garcia
Email: [email protected]
Department: Housekeeping
Position: Housekeeping Supervisor
Employee ID: EMP002

Assign Permissions

Default permissions for roles:

Front Desk Manager: Reservations, Guest Management, Check-in/out
Housekeeping Supervisor: Room Status, Cleaning Schedules
General Manager: All permissions

🎫 Step 5: Create Your First Reservation

Walk-in Reservation

Guest Information

First Name: Alice
Last Name: Smith
Email: [email protected]
Phone: +1 (555) 987-6543
Document Type: Passport
Document Number: AB123456

Reservation Details

Check-in Date: Today
Check-out Date: Tomorrow (+2 days)
Adults: 2
Children: 0
Room Type: Standard King Room
Rate: $150.00/night

Confirmation

System generates confirmation number: RES-2024-001
Room automatically assigned: 101
Total amount: $300.00 (2 nights)

Online Reservation (API)

# Create reservation via API
curl -X POST http://localhost:3333/api/reservations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "guest": {
      "first_name": "Alice",
      "last_name": "Smith",
      "email": "[email protected]",
      "phone": "+1 (555) 987-6543"
    },
    "check_in_date": "2024-01-15",
    "check_out_date": "2024-01-17",
    "adults": 2,
    "children": 0,
    "room_type_id": 1,
    "room_rate": 150.00
  }'

🔑 Step 6: Check-in Process

Guest Check-in

Locate Reservation

Search by confirmation number: RES-2024-001
Or search by guest name: Alice Smith

Verify Guest Information

Confirm identity document
Update contact information if needed
Collect payment method

Complete Check-in

Assign room key card
Set room status to "Occupied"
Generate folio
Print welcome letter

Mobile Check-in (Optional)

Guests can check-in using the mobile app:

http://localhost:3333/mobile/checkin/RES-2024-001

💳 Step 7: Process Payment

Payment Options

Cash Payment

Amount: $300.00
Method: Cash
Reference: CASH-001

Credit Card Payment

Amount: $300.00
Method: Credit Card
Card: **** **** **** 1234
Authorization: AUTH123456

Partial Payment

Deposit: $150.00 (50%)
Balance: $150.00 (due at checkout)

🧹 Step 8: Housekeeping Management

Room Status Updates

After Guest Departure

Status: Dirty
Housekeeping assigned: Maria Garcia

During Cleaning

Status: Out of Order (temporarily)
Estimated completion: 30 minutes

After Cleaning

Status: Clean
Inspection required: Yes
Ready for next guest: Yes

Housekeeping Dashboard

Access at: Dashboard > Housekeeping

View all room statuses
Assign cleaning tasks
Track completion times
Generate housekeeping reports

📊 Step 9: Basic Reporting

Daily Reports

Occupancy Report

Date: Today
Total Rooms: 8
Occupied: 1
Available: 7
Occupancy Rate: 12.5%

Revenue Report

Room Revenue: $150.00
Service Revenue: $0.00
Total Revenue: $150.00

Access Reports

Navigate to: Dashboard > Reports

Daily Flash Report
Occupancy Statistics
Revenue Analysis
Guest Demographics

🔧 Step 10: System Configuration

Essential Settings

Tax Configuration
```
City Tax: 5%
Service Tax: 10%
VAT: 8%
```
Email Templates

Booking confirmation
Check-in instructions
Check-out receipt

Notification Settings

New reservation alerts
Payment confirmations
Housekeeping updates

✅ Verification Checklist

Ensure everything is working correctly:

🎉 Congratulations!

You've successfully set up your first hotel property in Innkeeper! Your system is now ready for:

Multiple reservations and guest management
Advanced features like channel management
Reporting and analytics for business insights
Staff collaboration across departments

📚 Next Steps

Now that you have the basics running, explore these advanced features:

Hotel Management - Advanced property configuration
Reservation System - Complex booking scenarios
Multi-Tenant Architecture - Add more properties
API Documentation - Integrate with external systems
Billing & Payments - Advanced financial management

🆘 Need Help?

📖 Documentation: Wiki Home
🐛 Issues: GitHub Issues
💬 Community: GitHub Discussions
📧 Support: Contact the development team

← Previous: Installation Guide | Wiki Home | Next: Configuration →

Quick Start - gabrielmaialva33/innkeeper GitHub Wiki

⚡ Quick Start Guide

🎯 Overview

🏨 Step 1: Create Your First Organization

Using the Web Interface

Using CLI (Alternative)

🏢 Step 2: Set Up Your First Hotel Property

Create Hotel Property

Using API (Alternative)

🛏️ Step 3: Create Room Types and Rooms

Create Room Types

Create Individual Rooms

Bulk Room Creation (CLI)

👥 Step 4: Add Hotel Staff

Create Staff Roles

Assign Permissions

🎫 Step 5: Create Your First Reservation

Walk-in Reservation

Online Reservation (API)

🔑 Step 6: Check-in Process

Guest Check-in

Mobile Check-in (Optional)

💳 Step 7: Process Payment

Payment Options

🧹 Step 8: Housekeeping Management

Room Status Updates

Housekeeping Dashboard

📊 Step 9: Basic Reporting

Daily Reports

Access Reports

🔧 Step 10: System Configuration

Essential Settings

✅ Verification Checklist

🎉 Congratulations!

📚 Next Steps

🆘 Need Help?

⚠️ GitHub.com Fallback ⚠️

Quick Start - gabrielmaialva33/innkeeper GitHub Wiki

⚡ Quick Start Guide

🎯 Overview

🏨 Step 1: Create Your First Organization

Using the Web Interface

Using CLI (Alternative)

🏢 Step 2: Set Up Your First Hotel Property

Create Hotel Property

Using API (Alternative)

🛏️ Step 3: Create Room Types and Rooms

Create Room Types

Create Individual Rooms

Bulk Room Creation (CLI)

👥 Step 4: Add Hotel Staff

Create Staff Roles

Assign Permissions

🎫 Step 5: Create Your First Reservation

Walk-in Reservation

Online Reservation (API)

🔑 Step 6: Check-in Process

Guest Check-in

Mobile Check-in (Optional)

💳 Step 7: Process Payment

Payment Options

🧹 Step 8: Housekeeping Management

Room Status Updates

Housekeeping Dashboard

📊 Step 9: Basic Reporting

Daily Reports

Access Reports

🔧 Step 10: System Configuration

Essential Settings

✅ Verification Checklist

🎉 Congratulations!

📚 Next Steps

🆘 Need Help?

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️