pikku-deploy-uws

Deploy Pikku applications on uWebSockets.js with HTTP and WebSocket support.

56|Updated Apr 18, 2021
One-click install
npx skills add https://github.com/pikkujs/pikku --skill pikku-deploy-uws
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pikku-deploy-uws
Source: https://github.com/pikkujs/pikku/tree/main/.claude/skills/pikku-deploy-uws
Command: npx skills add https://github.com/pikkujs/pikku --skill pikku-deploy-uws

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Deploying high-performance Pikku servers can be challenging when you need built-in HTTP and WebSocket support and a clean deployment experience with a performant runtime.

Core Features & Use Cases

  • High-performance HTTP + WebSocket: Runs Pikku apps on uWebSockets.js for low-latency, scalable connections.
  • Dual deployment modes: Supports PikkuUWSServer for integrated HTTP/WS and pikkuWebsocketHandler for standalone WS setups.
  • Configurable lifecycle: Exposes init, start, stop, and enableExitOnSigInt for clean server lifecycle management.

Quick Start

Install the uWS dependency and initialize PikkuUWSServer with your config, then call init and start to run the server.

Frequently Asked Questions about pikku-deploy-uws

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deploy a Pikku application with uWS for HTTP and WebSocket support?

Deploy Pikku with uWS by initializing the PikkuUWSServer with your configuration, then calling its init and start lifecycle methods to run the high-performance server with built-in HTTP and WebSocket support.

Can I handle standalone WebSocket connections separately from HTTP in a Pikku deployment?

Yes, Pikku supports dual deployment modes: use PikkuUWSServer for integrated HTTP and WebSocket handling, or use pikkuWebsocketHandler for standalone WebSocket setups.

What lifecycle methods are available when running a Pikku server on uWebSockets.js?

The Pikku uWS deployment exposes init, start, and stop lifecycle methods, along with an enableExitOnSigInt option, to manage clean server startup and shutdown within deployment pipelines.

Does the uWS runtime support scalable, low-latency WebSocket connections for Pikku services?

Yes, running Pikku on the uWebSockets.js runtime provides low-latency, scalable WebSocket connections by leveraging the high-performance uWS library for both HTTP and WebSocket traffic.

Do I need to install uWebSockets.js separately to use the Pikku uWS deployment?

Yes, you need to install the uWS dependency separately before initializing the PikkuUWSServer with your configuration and calling the init and start methods to run the server.