Merge pull request #13 from noxify/docs

Docs

Author: noxify

.changeset/cold-trams-see.md

@@ -0,0 +1,8 @@
+---
+"create-vorsteh-queue": patch
+"@vorsteh-queue/adapter-drizzle": patch
+"@vorsteh-queue/adapter-prisma": patch
+"@vorsteh-queue/core": patch
+---
+
+update JSDOC descriptions

.changeset/loose-bikes-clap.md

@@ -0,0 +1,8 @@
+---
+"create-vorsteh-queue": patch
+"@vorsteh-queue/adapter-drizzle": patch
+"@vorsteh-queue/adapter-prisma": patch
+"@vorsteh-queue/core": patch
+---
+
+Updated dependencies

.gitignore

@@ -49,3 +49,4 @@ yarn-error.log*
 
 # turbo
 .turbo
+apps/docs/public/pagefind/

.prettierignore

@@ -1,2 +1,4 @@
 turbo/generators/scaffold/templates/**/*.hbs
-**/.cache
+**/.cache
+CHANGELOG.md
+**/CHANGELOG.md

.vscode/launch.json

@@ -2,12 +2,33 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "Next.js",
+      "name": "Next.js: debug server-side",
       "type": "node-terminal",
       "request": "launch",
-      "command": "pnpm dev",
-      "cwd": "${workspaceFolder}/apps/nextjs/",
-      "skipFiles": ["<node_internals>/**"]
+      "command": "pnpm dev:docs",
+      "cwd": "${workspaceFolder}/apps/docs"
+    },
+    {
+      "name": "Next.js: debug client-side",
+      "type": "chrome",
+      "request": "launch",
+      "url": "http://localhost:3000"
+    },
+    {
+      "name": "Next.js: debug full stack",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/apps/docs",
+      "program": "${workspaceFolder}/node_modules/next/dist/bin/next",
+      "runtimeArgs": ["--inspect"],
+      "skipFiles": ["<node_internals>/**"],
+      "serverReadyAction": {
+        "action": "debugWithChrome",
+        "killOnServerStop": true,
+        "pattern": "- Local:.+(https?://.+)",
+        "uriFormat": "%s",
+        "webRoot": "${workspaceFolder}"
+      }
     }
   ]
 }

.vscode/settings.json

@@ -11,8 +11,7 @@
     { "pattern": "tooling/*/" }
   ],
   "tailwindCSS.experimental.configFile": {
-    "apps/frontend/src/app/globals.css": ["apps/frontend/**"],
-    "packages/ui/src/styles/globals.css": ["packages/**", "apps/frontend/**"]
+    "apps/docs/src/app/globals.css": ["apps/docs/**"]
   },
   "tailwindCSS.emmetCompletions": true,
   "tailwindCSS.files.exclude": [

apps/docs/components.json

@@ -5,7 +5,7 @@
   "tsx": true,
   "tailwind": {
     "config": "",
-    "css": "app/globals.css",
+    "css": "src/app/globals.css",
     "baseColor": "neutral",
     "cssVariables": true,
     "prefix": ""

apps/docs/content/docs/01.getting-started/01.introduction.mdx

@@ -0,0 +1,33 @@
+---
+title: Introduction
+description: Get started with Vorsteh Queue, a powerful TypeScript-first job queue for PostgreSQL.
+---
+
+Vorsteh Queue is a powerful, type-safe queue engine designed for PostgreSQL 12+. It provides a robust solution for handling background jobs, scheduled tasks, and recurring processes in your Node.js applications.
+
+## Key Features
+
+- **Type-safe**: Full TypeScript support with generic job payloads
+- **Multiple adapters**: Drizzle ORM (PostgreSQL), Prisma ORM (PostgreSQL), and in-memory implementations
+- **Priority queues**: Numeric priority system (lower = higher priority)
+- **Delayed jobs**: Schedule jobs for future execution
+- **Recurring jobs**: Cron expressions and interval-based repetition
+- **UTC-first timezone support**: Reliable timezone handling with UTC storage
+- **Progress tracking**: Real-time job progress updates
+- **Event system**: Listen to job lifecycle events
+- **Graceful shutdown**: Clean job processing termination
+
+## Requirements
+
+- **Node.js 20+**
+- **ESM only** - This package is ESM-only
+- **PostgreSQL 12+** for production use
+
+## Architecture
+
+Vorsteh Queue follows a modular architecture with:
+
+- **Core package** - Contains the main queue logic and interfaces
+- **Adapter packages** - ORM-specific implementations
+- **UTC-first design** - All timestamps stored as UTC for consistency
+- **Event-driven** - Comprehensive event system for monitoring and debugging

apps/docs/content/docs/01.getting-started/02.installation.mdx

@@ -0,0 +1,76 @@
+---
+title: Installation
+description: Learn how to install Vorsteh Queue packages for your preferred ORM adapter.
+---
+
+## Prerequisites
+
+Before installing Vorsteh Queue, ensure you have:
+
+- **Node.js 20+**
+- **PostgreSQL 12+** database
+- **ESM project** - Add `"type": "module"` to your `package.json` or use `.mjs` file extensions
+
+## Quick Start with CLI (Recommended)
+
+The fastest way to get started is using the `create-vorsteh-queue` CLI tool:
+
+```bash
+# Interactive setup
+npx create-vorsteh-queue my-queue-app
+
+# Or with specific options
+npx create-vorsteh-queue worker-service \
+  --template=drizzle-postgres \
+  --package-manager=pnpm \
+  --quiet
+```
+
+### Available Templates
+
+- **drizzle-pg** - Basic Drizzle ORM with node-postgres
+- **drizzle-pglite** - Zero-setup with embedded PostgreSQL
+- **drizzle-postgres** - Advanced with recurring jobs
+- **event-system** - Comprehensive event monitoring
+- **progress-tracking** - Real-time progress updates
+- **pm2-workers** - Multi-process workers with PM2
+
+## Manual Installation
+
+If you prefer to add Vorsteh Queue to an existing project:
+
+### Drizzle ORM (PostgreSQL)
+
+<PackageInstall
+  packages={["@vorsteh-queue/core", "@vorsteh-queue/adapter-drizzle"]}
+  className={{ container: "not-prose", code: "not-prose" }}
+/>
+
+### Prisma ORM (PostgreSQL)
+
+<PackageInstall
+  packages={["@vorsteh-queue/core", "@vorsteh-queue/adapter-prisma"]}
+  className={{ container: "not-prose", code: "not-prose" }}
+/>
+
+## Database Setup
+
+After installation, you'll need to set up the required database tables. Each adapter provides migration scripts or schema definitions:
+
+- **Drizzle**: Use the provided schema and run migrations
+- **Prisma**: Add the schema to your `schema.prisma` and run `prisma migrate`
+
+Refer to the specific adapter documentation for detailed setup instructions.
+
+## Verify Installation
+
+Create a simple test file to verify your installation:
+
+```typescript
+import { Queue } from "@vorsteh-queue/core"
+
+// Your adapter import will vary based on your choice
+console.log("Vorsteh Queue installed successfully!")
+```
+
+Run the file with Node.js to confirm everything is working correctly.