Installation

System Requirements

Before installing Beils Dashboard, ensure your system meets these requirements:

Minimum Requirements

Server Requirements

OS: Linux (Ubuntu 20.04+), macOS 10.15+, or Windows 10+
RAM: 2GB minimum, 4GB recommended
Storage: 5GB free space
CPU: 2 cores minimum

Software Requirements

Node.js: v18.0.0 or higher (v20.x recommended)
pnpm: v8.0.0 or higher
MariaDB/MySQL: v10.6 or higher
Git: v2.20 or higher

Prerequisites Installation

Ubuntu/Debian
macOS
Windows

# Update package list
sudo apt update

# Install Node.js 20.x
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs

# Install pnpm
npm install -g pnpm

# Install MariaDB
sudo apt install -y mariadb-server mariadb-client

# Secure MariaDB installation
sudo mysql_secure_installation

# Install Git
sudo apt install -y git

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Node.js
brew install node@20

# Install pnpm
npm install -g pnpm

# Install MariaDB
brew install mariadb
brew services start mariadb

# Secure MariaDB
sudo mysql_secure_installation

# Install using Chocolatey package manager
# First install Chocolatey: https://chocolatey.org/install

# Install Node.js
choco install nodejs-lts

# Install pnpm
npm install -g pnpm

# Download and install MariaDB from:
# https://mariadb.org/download/

# Install Git
choco install git

Verify installations by running:

node --version (should be v18+)
pnpm --version
mysql --version or mariadb --version
git --version

Development Installation

Clone the Repository

Get the source code from your repository:

git clone <your-repository-url> beils-dashboard
cd beils-dashboard

Install Dependencies

Install all required npm packages:

pnpm install

This installs the following key dependencies:

Framework & Core

[email protected] - Full-stack Vue framework
[email protected] - Progressive JavaScript framework
[email protected] - Official Vue router
@pinia/[email protected] - State management

Database & ORM

@prisma/[email protected] - Type-safe database client
@prisma/[email protected] - MariaDB adapter
[email protected] - Prisma CLI and schema tools
mariadb@^3.5.1 - MariaDB connector

Authentication & Security

bcryptjs@^3.0.3 - Password hashing
jsonwebtoken@^9.0.3 - JWT token generation/verification
[email protected] - Schema validation

UI & Styling

@tailwindcss/[email protected] - Tailwind CSS v4
[email protected] - Utility-first CSS framework
daisyui@^5.5.19 - Tailwind component library
[email protected] - Icon library

Data Fetching & State

@tanstack/[email protected] - Powerful data synchronization
[email protected] - Vue state management

Additional Features

[email protected] - Internationalization
echarts@^6.0.0 - Data visualization charts
vue-echarts@^8.0.1 - Vue wrapper for ECharts
html2pdf.js@^0.14.0 - PDF generation
[email protected] - Scroll animations

Database Setup

Create a new MariaDB/MySQL database:

# Connect to MariaDB
sudo mysql -u root -p

-- Create database
CREATE DATABASE transpallet_plus_db 
CHARACTER SET utf8mb4 
COLLATE utf8mb4_unicode_ci;

-- Create dedicated user (recommended for production)
CREATE USER 'beils_user'@'localhost' IDENTIFIED BY 'secure_password_here';

-- Grant privileges
GRANT ALL PRIVILEGES ON transpallet_plus_db.* TO 'beils_user'@'localhost';
FLUSH PRIVILEGES;

-- Exit
EXIT;

For production, use a strong password and consider limiting privileges to only what’s needed (SELECT, INSERT, UPDATE, DELETE).

Environment Configuration

Create a .env file in the project root:

.env

# ===========================================
# DATABASE CONFIGURATION
# ===========================================
# MariaDB/MySQL connection settings
DATABASE_HOST=localhost
DATABASE_USER=beils_user
DATABASE_PASSWORD=secure_password_here
DATABASE_NAME=transpallet_plus_db
DATABASE_PORT=3306

# ===========================================
# AUTHENTICATION
# ===========================================
# JWT secret for token signing (use a long random string)
JWT_SECRET=your-super-secret-jwt-key-min-32-characters-long

# ===========================================
# APPLICATION SETTINGS
# ===========================================
NODE_ENV=development

# Optional: Custom port for dev server (default 3000)
# PORT=3000

# Optional: Base URL for production
# BASE_URL=https://yourdomain.com

Generate a secure JWT secret using:

node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

Prisma Setup

Initialize Prisma and generate the client:

# Generate Prisma Client based on schema
pnpm prisma:generate

The Prisma schema is located at prisma/schema.prisma and includes:

User management with roles (ADMIN, USER)
Client CRM (consents, questionnaires, revokes)
Product catalog (brands, categories, subcategories, tags)
Services and packs
Marketing tools (coupons, bonuses, gift cards)
Point of sale (carts, cart items, debts)
Appointment booking system

Database Migration

Apply the schema to your database:

pnpm prisma:migrate

This creates all tables, indexes, foreign keys, and constraints defined in the schema.

Migration name will be “init” by default. The migration files are stored in prisma/migrations/.

Database Seeding

Populate the database with initial data:

pnpm seed

The seed script (seeds/seed-db.ts) creates:Users (25 total)

1 Admin: [email protected] / password123
2 Staff members (ADMIN role)
22 Clients (USER role)

Brands

Masglo
Bioline Jato

Client Data

0-3 consent forms per client
0-2 questionnaires per client
0-5 bookings per client (past and future)

The seed script will delete all existing data before seeding. Only run this in development!

Start Development Server

Launch the application:

pnpm dev

The server will start at http://localhost:3000 with:

Hot module replacement (HMR)
TypeScript type checking
Automatic compilation
API routes at /api/*

Access the dashboard and login with:

Email: [email protected]
Password: password123

Production Installation

Environment Setup

Create a production .env file:

.env

# Production database configuration
DATABASE_HOST=your-db-host.com
DATABASE_USER=production_user
DATABASE_PASSWORD=strong-production-password
DATABASE_NAME=beils_production_db
DATABASE_PORT=3306

# Strong JWT secret (64+ characters recommended)
JWT_SECRET=<64-character-random-string>

# Production settings
NODE_ENV=production
BASE_URL=https://yourdomain.com

Build the Application

Create an optimized production build:

pnpm build

This generates:

Minified JavaScript bundles
Optimized CSS
Pre-rendered pages
Server-side code in .output/

Database Migration

Run migrations on production database:

pnpm prisma:migrate

Always backup your production database before running migrations!

Start Production Server

Run the production build:

node .output/server/index.mjs

Or use the preview command for local testing:

pnpm preview

Deployment Options

Option 1: Traditional Server (VPS/Dedicated)

Server Setup

# Install Node.js and PM2 process manager
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs
npm install -g pm2

Deploy Application

# Clone and build
git clone <repo> /var/www/beils-dashboard
cd /var/www/beils-dashboard
pnpm install
pnpm build

# Start with PM2
pm2 start .output/server/index.mjs --name beils-dashboard
pm2 save
pm2 startup

Configure Nginx

server {
    listen 80;
    server_name yourdomain.com;
    
    location / {
        proxy_pass http://localhost:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
}

Option 2: Docker Deployment

Create a Dockerfile:

FROM node:20-alpine

WORKDIR /app

# Copy package files
COPY package.json pnpm-lock.yaml ./

# Install pnpm and dependencies
RUN npm install -g pnpm
RUN pnpm install --frozen-lockfile

# Copy application files
COPY . .

# Generate Prisma client
RUN pnpm prisma:generate

# Build application
RUN pnpm build

EXPOSE 3000

# Start application
CMD ["node", ".output/server/index.mjs"]

Create docker-compose.yml:

version: '3.8'

services:
  app:
    build: .
    ports:
      - "3000:3000"
    environment:
      - DATABASE_HOST=db
      - DATABASE_USER=beils
      - DATABASE_PASSWORD=secure_password
      - DATABASE_NAME=beils_db
      - JWT_SECRET=${JWT_SECRET}
      - NODE_ENV=production
    depends_on:
      - db
  
  db:
    image: mariadb:10.11
    environment:
      - MYSQL_ROOT_PASSWORD=root_password
      - MYSQL_DATABASE=beils_db
      - MYSQL_USER=beils
      - MYSQL_PASSWORD=secure_password
    volumes:
      - db_data:/var/lib/mysql
    ports:
      - "3306:3306"

volumes:
  db_data:

Deploy with Docker:

# Build and start
docker-compose up -d

# Run migrations
docker-compose exec app pnpm prisma:migrate

# View logs
docker-compose logs -f app

Option 3: Platform-as-a-Service

Vercel
Netlify
Railway

# Install Vercel CLI
npm install -g vercel

# Deploy
vercel

# Configure environment variables in Vercel dashboard
# Set DATABASE_* and JWT_SECRET variables

Ensure your database is accessible from Vercel’s infrastructure (may require whitelisting IPs or using managed database).

Create netlify.toml:

[build]
  command = "pnpm build"
  publish = ".output/public"

[[redirects]]
  from = "/*"
  to = "/.netlify/functions/server"
  status = 200

# Install Railway CLI
npm install -g @railway/cli

# Login and deploy
railway login
railway init
railway up

# Add database
railway add mariadb

Database Management

Prisma Commands

Command	Description
`pnpm prisma:generate`	Generate Prisma Client
`pnpm prisma:migrate`	Create and apply migrations
`pnpm prisma:pull`	Pull schema from existing database
`pnpm prisma:reset`	Reset database (delete all data)
`pnpx prisma studio`	Open Prisma Studio (database GUI)

Backup and Restore

Backup database:

mysqldump -u beils_user -p transpallet_plus_db > backup.sql

Restore database:

mysql -u beils_user -p transpallet_plus_db < backup.sql

Schedule regular backups using cron:

# Daily backup at 2 AM
0 2 * * * mysqldump -u user -p'password' db > /backups/$(date +\%Y\%m\%d).sql

SSL/TLS Configuration

For production, always use HTTPS:

Obtain SSL Certificate

# Using Let's Encrypt (free)
sudo apt install certbot python3-certbot-nginx
sudo certbot --nginx -d yourdomain.com

Configure Nginx for HTTPS

server {
    listen 443 ssl http2;
    server_name yourdomain.com;
    
    ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;
    
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header Host $host;
    }
}

# Redirect HTTP to HTTPS
server {
    listen 80;
    server_name yourdomain.com;
    return 301 https://$server_name$request_uri;
}

Auto-renewal

# Test renewal
sudo certbot renew --dry-run

# Certificates auto-renew via cron

Performance Optimization

Database Optimization

-- Add indexes for frequently queried fields
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_bookings_date ON bookings(booking_date);
CREATE INDEX idx_products_sku ON products(sku);

-- Optimize tables
OPTIMIZE TABLE users, bookings, products;

Application Optimization

// nuxt.config.ts - Production optimizations
export default defineNuxtConfig({
  vite: {
    build: {
      minify: 'terser',
      cssMinify: true,
    },
  },
  nitro: {
    compressPublicAssets: true,
    minify: true,
  },
})

Monitoring and Logs

Application Logs

# PM2 logs
pm2 logs beils-dashboard
pm2 logs beils-dashboard --lines 100

# Save logs to file
pm2 logs beils-dashboard > logs.txt

Database Logs

-- Enable query logging (MariaDB)
SET GLOBAL general_log = 'ON';
SET GLOBAL general_log_file = '/var/log/mysql/query.log';

Troubleshooting

Build fails with Prisma errors

# Clear Prisma cache and regenerate
rm -rf node_modules/.prisma
pnpm prisma:generate
pnpm build

Database connection timeout

Check firewall rules allow port 3306
Verify database host is reachable: ping your-db-host
Increase connection timeout in prisma.config.ts
Check database user permissions

Port already in use

# Find and kill process using port 3000
lsof -ti:3000 | xargs kill -9

# Or use a different port
PORT=3001 pnpm dev

JWT token errors

Ensure JWT_SECRET is set in .env
Verify token hasn’t expired (24h default)
Check for special characters in secret that need escaping
Clear browser cookies/localStorage and re-login

Memory issues in production

# Increase Node.js memory limit
NODE_OPTIONS="--max-old-space-size=4096" node .output/server/index.mjs

# Or in PM2
pm2 start .output/server/index.mjs --name beils --node-args="--max-old-space-size=4096"

Security Checklist

Next Steps

API Reference

Explore the complete API documentation

Administration

Learn how to configure and manage your Beils Dashboard

Join our community for support, updates, and best practices for running Beils Dashboard in production.

Get Started

Core Features

User Guides

Administration

System Requirements

Minimum Requirements

Server Requirements

Software Requirements

Prerequisites Installation

Development Installation

Production Installation

Deployment Options

Option 1: Traditional Server (VPS/Dedicated)

Option 2: Docker Deployment

Option 3: Platform-as-a-Service

Database Management

Prisma Commands

Backup and Restore

SSL/TLS Configuration

Performance Optimization

Database Optimization

Application Optimization

Monitoring and Logs

Application Logs

Database Logs

Troubleshooting

Security Checklist

Next Steps

API Reference

Administration

Build docs developers (and LLMs) love

Get Started

Core Features

User Guides

Administration

​System Requirements

​Minimum Requirements

Server Requirements

Software Requirements

​Prerequisites Installation

​Development Installation

​Production Installation

​Deployment Options

​Option 1: Traditional Server (VPS/Dedicated)

​Option 2: Docker Deployment

​Option 3: Platform-as-a-Service

​Database Management

​Prisma Commands

​Backup and Restore

​SSL/TLS Configuration

​Performance Optimization

​Database Optimization

​Application Optimization

​Monitoring and Logs

​Application Logs

​Database Logs

​Troubleshooting

​Security Checklist

​Next Steps

API Reference

Administration

Build docs developers (and LLMs) love

System Requirements

Minimum Requirements

Prerequisites Installation

Development Installation

Production Installation

Deployment Options

Option 1: Traditional Server (VPS/Dedicated)

Option 2: Docker Deployment

Option 3: Platform-as-a-Service

Database Management

Prisma Commands

Backup and Restore

SSL/TLS Configuration

Performance Optimization

Database Optimization

Application Optimization

Monitoring and Logs

Application Logs

Database Logs

Troubleshooting

Security Checklist

Next Steps