Skip to main content

🚀 Installation Guide

This guide will walk you through the installation process for the core Rahat platform components: rahat-platform and rahat-ui.

📋 Prerequisites​

Before you begin the installation, ensure you have all the required dependencies installed as mentioned in the Prerequisites page.

🏗️ Core Platform Installation​

Step 1: Clone the Platform Repository​

# Clone the rahat-platform repository
git clone https://github.com/rahataid/rahat-platform.git
cd rahat-platform

Step 2: Install Dependencies​

# Bootstrap the platform - this installs all dependencies and builds the platform
pnpm bootstrap

Step 3: Environment Configuration​

# Copy the environment configuration file
cp .env.example .env

Important: Edit the .env file with your specific configuration values before proceeding.

Step 4: Start the Platform​

# Run the platform in development mode
pnpm run start:dev

The platform will be available at http://localhost:3001 by default.

🎨 UI Installation​

Step 1: Clone the UI Repository​

# Clone the rahat-ui repository
git clone https://github.com/rahataid/rahat-ui.git
cd rahat-ui

Step 2: Install Dependencies​

# Install all dependencies
pnpm i

Step 3: Environment Configuration​

# Copy the environment configuration file
cp .env.example .env

Important: Edit the .env file with your specific configuration values before proceeding.

Step 4: Start the UI​

# Run the UI in development mode
pnpm run dev

The UI will be available at http://localhost:3000 by default.

🔧 Development Scripts​

Both repositories include helpful development scripts:

CommandDescription
pnpm run devStart services in development mode
pnpm run buildBuild all packages
pnpm run testRun tests across all packages
pnpm run lintRun linting across all packages

✅ Verification​

After installation, verify your setup:

  1. Platform Health Check: Visit http://localhost:3001/api/health
  2. UI Access: Visit http://localhost:3000
  3. Default Login Credentials:
    • Email: admin@example.com
    • Password: rahat123

🚀 Running the Complete Stack​

To run both components together:

  1. Start the Platform (Terminal 1):

    cd rahat-platform
    pnpm run start:dev

  2. Start the UI (Terminal 2):

    cd rahat-ui
    pnpm run dev

  3. Access the Application:

    • UI: http://localhost:3000
    • API: http://localhost:3001

🔗 Next Steps​

After successful installation:

  1. Project Implementation: Set up a specific project implementation (CVA, C2C, etc.)
  2. Configuration: Configure environment variables for your specific use case
  3. Development: Start developing with the platform

For project-specific setup guides, see the Project Modules section.

❓ Troubleshooting​

If you encounter issues during installation:

  1. Check Prerequisites: Ensure all required dependencies are installed
  2. Environment Variables: Verify your .env configuration
  3. Port Conflicts: Ensure ports 3000 and 3001 are available
  4. Dependencies: Try clearing node_modules and reinstalling

For detailed troubleshooting, refer to the Troubleshooting Guide.

📚 Additional Resources​