Installation Guide

This guide will help you install and set up Reqbeam on your system.

Prerequisites

Before installing Reqbeam, ensure you have the following installed:

Node.js version 18.0 or higher (Download)
npm, yarn, or pnpm package manager
PostgreSQL version 14 or higher (for production) or SQLite (for development)
Git version control system (Download)

Installation Methods

Method 1: Clone from GitHub

# Clone the repository
git clone https://github.com/reqbeam/reqbeam.git
cd reqbeam

# Install dependencies
npm install

# Set up environment variables
cp env.example .env
# Edit .env with your configuration

# Set up database
npm run db:generate
npm run db:push

# Start development server
npm run dev

Method 2: Using Docker

# Clone the repository
git clone https://github.com/reqbeam/reqbeam.git
cd reqbeam

# Start with Docker Compose
docker-compose up -d

Method 3: Automated Setup Script

# Clone the repository
git clone https://github.com/reqbeam/reqbeam.git
cd reqbeam

# Run automated setup (Linux/Mac)
chmod +x setup.sh
./setup.sh

# Or run manually
npm run setup:all

Environment Configuration

1. Copy Environment Template

cp env.example .env

2. Configure Environment Variables

Edit the .env file with your configuration:

# Database
DATABASE_URL="postgresql://username:password@localhost:5432/reqbeam?schema=public"
# Or for SQLite: DATABASE_URL="file:./prisma/dev.db"

# NextAuth Configuration
NEXTAUTH_URL="http://localhost:3000"
NEXTAUTH_SECRET="your-secret-key-here"

# App Configuration
NEXT_PUBLIC_APP_NAME="Reqbeam"

### 3. Generate NEXTAUTH_SECRET

```bash
# Linux/Mac
openssl rand -base64 32

# Or using Node.js
node -e "console.log(require('crypto').randomBytes(32).toString('base64'))"

Database Setup

PostgreSQL Setup

Create Database

psql -U postgres
CREATE DATABASE reqbeam;
\q

Run Migrations

npm run db:generate
npm run db:push

SQLite Setup

Update .env

DATABASE_URL="file:./prisma/dev.db"

Run Setup

npm run db:generate
npm run db:push

CLI Installation

To install the Reqbeam CLI tool:

cd reqbeam-cli
npm install
npm run build
npm link  # Install globally

# Authenticate
reqbeam auth login
# or use alias
rb auth login

Verification

Verify Web Application

Start the development server:
```
npm run dev
```
Open http://localhost:3000 in your browser
You should see the Reqbeam login page

Verify CLI

reqbeam --version
# or
rb --version

Troubleshooting

Database Connection Issues

# Check if PostgreSQL is running
sudo service postgresql status  # Linux
brew services list              # Mac

# Restart PostgreSQL
sudo service postgresql restart  # Linux
brew services restart postgresql # Mac

Prisma Client Issues

# Regenerate Prisma Client
npm run db:generate

Port Already in Use

# On Linux/Mac
lsof -ti:3000 | xargs kill -9

# On Windows
netstat -ano | findstr :3000
taskkill /PID <PID> /F

Next Steps

After installation, proceed to the Quick Start Guide to begin using Reqbeam.