Skip to content

Quick Start Guide

Get up and running with the CyferWall Support Backend in minutes.

Prerequisites

  • Node.js 18+
  • npm or bun
  • PostgreSQL database
  • Python 3.8+ (for documentation)

Installation

  1. Clone and install dependencies 

    git clone <repository-url>
cd backend
npm install

  2. Set up environment variables 

    cp .env.example .env
# Edit .env with your database and API keys

  3. Initialize database 

    npx prisma migrate dev
npx prisma generate

  4. Start development server 

    npm run dev

The backend will be running at http://localhost:3000

First API Test

Test the health check endpoint: 

curl http://localhost:3000/health

Expected response: 

{
  "status": "OK",
  "timestamp": "2025-07-22T13:00:00.000Z"
}

Create Your First Support Case

curl -X POST http://localhost:3000/api/support/case \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "customerType": "PREMIUM",
    "issueType": "TECHNICAL",
    "urgency": "HIGH",
    "subject": "API Integration Issue",
    "message": "Having trouble with the authentication API"
  }'

Next Steps

Common Issues

Database connection errors? - Check your DATABASE_URL in .env - Ensure PostgreSQL is running - Run npx prisma migrate reset to reset schema

Build errors? - Clear node_modules: rm -rf node_modules && npm install - Check TypeScript version: npx tsc --version - Run type check: npx tsc --noEmit

Notification errors? - Verify email provider settings in .env - Check template files exist in /templates/notifications/ - Test with: npm run test:notifications

Need Help?