evershop start - EverShop

Overview

The evershop start command starts your EverShop application in production mode. It serves the optimized bundles created by evershop build.

Usage

evershop start

Prerequisites

Before running evershop start, you must:

Complete the installation: evershop install
Build the application: evershop build
Configure environment variables in .env

What It Does

The start command:

Loads production environment configuration
Initializes database connections
Loads modules and extensions
Runs bootstrap scripts
Starts the Express HTTP server
Serves pre-built static assets
Handles API and GraphQL requests

Implementation

From src/bin/start/index.ts:

import './initEnvStart.js';
import { start } from '../lib/startUp.js';

start({
  command: 'start',
  env: 'production',
  process: 'main'
});

Production Environment

Environment Variables

Required environment variables:

# .env file
DB_HOST=localhost
DB_PORT=5432
DB_NAME=evershop
DB_USER=postgres
DB_PASSWORD=your_password
DB_SSLMODE=require

Configuration

Production configuration in config/production.json:

{
  "system": {
    "port": 3000,
    "logLevel": "error"
  },
  "database": {
    "pool": {
      "max": 20,
      "min": 5
    }
  }
}

Server Configuration

Port

Default port is 3000. Configure in config/production.json:

{
  "system": {
    "port": 8080
  }
}

Or use environment variable:

PORT=8080 evershop start

Host Binding

By default, the server binds to all interfaces (0.0.0.0). Configure specific host:

{
  "system": {
    "host": "127.0.0.1"
  }
}

Process Management

Using PM2

Recommended for production:

# Install PM2
npm install -g pm2

# Start with PM2
pm2 start "evershop start" --name evershop

# View logs
pm2 logs evershop

# Restart
pm2 restart evershop

# Stop
pm2 stop evershop

PM2 Ecosystem File

// ecosystem.config.js
module.exports = {
  apps: [{
    name: 'evershop',
    script: 'evershop',
    args: 'start',
    instances: 2,
    exec_mode: 'cluster',
    env: {
      NODE_ENV: 'production',
      PORT: 3000
    }
  }]
};

Start with ecosystem:

pm2 start ecosystem.config.js

Using systemd

Create a systemd service:

# /etc/systemd/system/evershop.service
[Unit]
Description=EverShop E-commerce Platform
After=network.target

[Service]
Type=simple
User=www-data
WorkingDirectory=/var/www/evershop
ExecStart=/usr/bin/node /usr/local/bin/evershop start
Restart=on-failure
Environment=NODE_ENV=production

[Install]
WantedBy=multi-user.target

Enable and start:

sudo systemctl enable evershop
sudo systemctl start evershop
sudo systemctl status evershop

Using Docker

# Dockerfile
FROM node:18-alpine

WORKDIR /app

# Copy package files
COPY package*.json ./
RUN npm install --production

# Copy application
COPY . .

# Build
RUN npm run build

# Start
CMD ["npm", "run", "start"]

Build and run:

docker build -t evershop .
docker run -p 3000:3000 --env-file .env evershop

Performance Optimization

Database Connection Pooling

Configure connection pool size:

{
  "database": {
    "pool": {
      "min": 5,
      "max": 20,
      "idleTimeoutMillis": 30000
    }
  }
}

Caching

Enable Redis caching:

{
  "cache": {
    "enabled": true,
    "type": "redis",
    "redis": {
      "host": "localhost",
      "port": 6379
    }
  }
}

Static Asset Serving

Use Nginx as reverse proxy:

server {
    listen 80;
    server_name example.com;

    location /assets/ {
        alias /var/www/evershop/public/assets/;
        expires 1y;
        add_header Cache-Control "public, immutable";
    }

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

Monitoring

Health Check Endpoint

Check if server is running:

curl http://localhost:3000/health

Logging

Production logs are written to:

logs/error.log - Error logs
logs/combined.log - All logs

Configure log level:

{
  "system": {
    "logLevel": "error"
  }
}

Metrics

Monitor with PM2:

pm2 monit

Or use monitoring services:

New Relic
DataDog
Prometheus + Grafana

Graceful Shutdown

The server handles shutdown signals:

process.on('SIGTERM', async () => {
  // Close database connections
  // Finish pending requests
  // Exit cleanly
  process.exit(0);
});

Graceful shutdown:

kill -SIGTERM <pid>

Scaling

Horizontal Scaling

Run multiple instances:

# Using PM2 cluster mode
pm2 start evershop start -i 4

Load Balancing

Use Nginx for load balancing:

upstream evershop {
    server localhost:3000;
    server localhost:3001;
    server localhost:3002;
    server localhost:3003;
}

server {
    listen 80;
    location / {
        proxy_pass http://evershop;
    }
}

Troubleshooting

Server Won’t Start

Error: Cannot find module '.evershop/build'

Solution: Run evershop build first.

Port Already in Use

Error: Port 3000 is already in use

Solution: Change port or stop existing process:

lsof -ti:3000 | xargs kill -9

Database Connection Failed

Error: Connection terminated

Solution: Check database credentials and connectivity:

psql -h localhost -U postgres -d evershop

Out of Memory

JavaScript heap out of memory

Solution: Increase Node.js memory:

NODE_OPTIONS="--max-old-space-size=4096" evershop start

Security

Environment Variables

Never commit .env to version control:

# .gitignore
.env
.env.production

HTTPS

Use reverse proxy (Nginx/Apache) for SSL:

server {
    listen 443 ssl http2;
    ssl_certificate /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;
    
    location / {
        proxy_pass http://localhost:3000;
    }
}

Security Headers

Configure in reverse proxy:

add_header X-Frame-Options "SAMEORIGIN";
add_header X-Content-Type-Options "nosniff";
add_header X-XSS-Protection "1; mode=block";

Example Startup Output

$ evershop start

Loading production configuration...
✓ Configuration loaded

Connecting to database...
✓ Database connected

Loading modules...
✓ 8 core modules loaded
✓ 2 extensions loaded

Running bootstrap scripts...
✓ Bootstrap completed

Starting server...
✓ Server listening on http://localhost:3000

EverShop is ready for production!

evershop build - Build for production
evershop dev - Development server
evershop install - Initial setup

CLI Commands

Core APIs

GraphQL

Module Services

​Overview

​Usage

​Prerequisites

​What It Does

​Implementation

​Production Environment

​Environment Variables

​Configuration

​Server Configuration

​Port

​Host Binding

​Process Management

​Using PM2

​PM2 Ecosystem File

​Using systemd

​Using Docker

​Performance Optimization

​Database Connection Pooling

​Caching

​Static Asset Serving

​Monitoring

​Health Check Endpoint

​Logging

​Metrics

​Graceful Shutdown

​Scaling

​Horizontal Scaling

​Load Balancing

​Troubleshooting

​Server Won’t Start

​Port Already in Use

​Database Connection Failed

​Out of Memory

​Security

​Environment Variables

​HTTPS

​Security Headers

​Example Startup Output

​Related Commands

Build docs developers (and LLMs) love

Overview

Usage

Prerequisites

What It Does

Implementation

Production Environment

Environment Variables

Configuration

Server Configuration

Port

Host Binding

Process Management

Using PM2

PM2 Ecosystem File

Using systemd

Using Docker

Performance Optimization

Database Connection Pooling

Caching

Static Asset Serving

Monitoring

Health Check Endpoint

Logging

Metrics

Graceful Shutdown

Scaling

Horizontal Scaling

Load Balancing

Troubleshooting

Server Won’t Start

Port Already in Use

Database Connection Failed

Out of Memory

Security

Environment Variables

HTTPS

Security Headers

Example Startup Output

Related Commands