Skip to main content

Installation

This guide covers the installation process for the Hospitality Management Platform.

Prerequisites​

Before installing HMP, ensure you have the following:

  • Node.js 18.x or later
  • PostgreSQL 14.x or later
  • Redis 7.x or later
  • npm or yarn package manager

Installation Methods​

HMP Cloud is the recommended deployment option for most organizations:

  1. Sign up at hmpcloud.com
  2. Create a new property
  3. Configure your settings
  4. Start using HMP immediately

Self-Hosted Installation​

For organizations requiring on-premise deployment:

1. Clone the Repository​

git clone https://github.com/hmp/hmp-platform.git
cd hmp-platform

2. Install Dependencies​

npm install

3. Set Up Environment Variables​

Copy the example environment file and configure:

cp .env.example .env

Edit .env with your database credentials and other settings:

# Database
DATABASE_URL=postgresql://user:password@localhost:5432/hmp

# Redis
REDIS_URL=redis://localhost:6379

# JWT Secret
JWT_SECRET=your-secure-secret-key

# API Settings
API_PORT=3000

4. Initialize the Database​

npm run db:migrate
npm run db:seed

5. Start the Application​

# Development mode
npm run dev

# Production mode
npm run build
npm run start

Docker Installation​

For containerized deployments:

# Build the image
docker build -t hmp-platform .

# Run with Docker Compose
docker-compose up -d

Kubernetes Deployment​

Helm charts are available for Kubernetes deployments:

helm repo add hmp https://charts.hmpcloud.com
helm install hmp hmp/hmp-platform

Verification​

After installation, verify the system is running:

# Check API health
curl http://localhost:3000/health

# Expected response
{"status":"healthy","version":"1.0.0"}

Next Steps​