PropVault CMS — Standalone Distribution

PropVault is a high-performance, enterprise-grade Website Builder and CMS framework designed specifically for real estate developers, property brokers, and luxury leasing pipelines.

This package is the pre-compiled, code-free standalone Next.js server distribution of the CMS. It allows you to run, manage, and scale the CMS using only configuration templates and the built-in CLI command utility.

🌐 Official Portals & Support

• Documentation Portal: https://propvault.vikshro.in
• Official Website: https://propvault.vikshro.in
• Enterprise Support: [email protected]

🚀 Installation & Setup Guide

Follow these steps to deploy PropVault in your workspace:

Step 1: Initialize the Workspace

Run the initializer command inside your installation directory. This scaffolds all required storage, plugins, and configuration structures:

npx @vikukumar/propvault init

This generates the following files and folders:

• /data & /storage: Local database folders.
• /plugins: Subdirectory for custom integration modules.
• .env: Active workspace environment variables.

Step 2: Configure Environment Variables

Open the .env file and verify your keys. The following parameters are supported:

# Server Port (default is 3000)
PORT=3000

# Database URL connection string (SQLite, PostgreSQL, MySQL, MSSQL, MongoDB)
DATABASE_URL=sqlite://./data/propvault.db

# Authentication secret key
NEXTAUTH_SECRET=propvault_secure_token_key_generation_9988

Step 3: Run the Production Server

Launch the server with the integrated zero-downtime Blue-Green hot-reload proxy:

npx @vikukumar/propvault start

Step 4: Complete the Browser Setup Wizard

Navigate to http://localhost:3000/setup in your web browser.

1. Prerequisites Check: The installer runs checks to verify write permissions and driver modules.
2. License Key: Enter your optional Enterprise License Key. If left blank, the system bootstrap state registers as Open Source Software (oss).
3. Database Handshake: Pings the database server, registers all 50 tables, and seeds initial menus.
4. Admin Setup: Configure your primary administrator email and password credentials.

💻 Command Line Interface (CLI) Guide

PropVault includes a built-in CLI to perform admin tasks directly from your terminal:

| Command | Description | |---|---| | npx @vikukumar/propvault init | Scaffolds default folder directories and .env config files. | | npx @vikukumar/propvault start | Starts the production server with hot-reload proxy support. | | npx @vikukumar/propvault db:migrate | Synchronizes active schemas across your database models. | | npx @vikukumar/propvault db:seed | Seeds luxury layout templates, menus, and geo presets. | | npx @vikukumar/propvault plugin:list | Lists all discovered plugins and active statuses. | | npx @vikukumar/propvault plugin:activate <slug> | Activates a plugin hook registry. | | npx @vikukumar/propvault plugin:deactivate <slug> | Deactivates a plugin hook registry. |

🔌 PDK & Extensibility

Developers can build custom plugins using the isolated Plugin Development Kit (PDK).

Install the PDK utility to scaffold integrations:

npx @vikukumar/propvault-pdk create my-plugin

Refer to the Official Documentation Portal for full API guides on action hooks (after_lead_submit) and filter hooks (before_project_save).

⚖️ Licensing

PropVault operates under a dual distribution model.

• Open Source Version (OSS): Free for commercial and personal use under the terms of the MIT license.
• Enterprise Version: Unlocks advanced workflows (audit logs, multi-tenant databases, multi-region syncing). Contact our team for licensing options.