Installation

Development Installation

git clone https://github.com/dlampatricio/better-reports.git
cd better-reports
npm install
npm run build:binary
npm run dev

The development server starts both the backend (localhost:3000) and frontend (localhost:5173) with hot-reload.

Production Installation (Manual)

1. Build the Application

npm install
npm run build:binary
npm run build:ui

2. Start the Server

NODE_ENV=production \
  REPORTS_PORT=3000 \
  REPORTS_TEMPLATES_DIR=/opt/better-reports/templates \
  REPORTS_ASSETS_DIR=/opt/better-reports/assets \
  REPORTS_USER=admin \
  REPORTS_PASS=your-password \
  node src/server.mjs

3. Configure Reverse Proxy (Optional)

The app listens on port 3000 by default. For production, use a reverse proxy:

Nginx:

server {
  listen 443 ssl;
  server_name reports.yourdomain.com;

  location / {
    proxy_pass http://127.0.0.1:3000;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
  }
}

Docker Installation

See the Docker deployment guide.

PM2 Installation

See the PM2 deployment guide.

System Requirements

Component	Requirement
Node.js	>= 18
Rust	Latest stable (for native addon build)
RAM	256 MB minimum, 1 GB recommended
Disk	500 MB for base install, plus template storage
OS	Linux, macOS, Windows (WSL2 recommended)