create-zoltraak

Scaffold a new Zoltraak project with a single command.

Usage

Create a new project

# Interactive (prompts for name, template, git, deps)
bunx create-zoltraak

# Non-interactive
bunx create-zoltraak my-app

This will create a new Zoltraak project in the my-app directory with the basic template.

Choose a template

# Basic template (default)
bunx create-zoltraak my-app

# Advanced template with organized structure
bunx create-zoltraak my-app --template advanced

# CRUD API with database
bunx create-zoltraak my-api --template crud

# Real-time chat application
bunx create-zoltraak my-chat --template realtime

# Full-stack application
bunx create-zoltraak my-fullstack --template fullstack

You can also use Bun's create shortcut:

bun create zoltraak my-app

Templates

Basic Template

A minimal starting point with:

• Simple route setup
• TypeScript configuration
• Development scripts
• Basic examples

Perfect for small projects and quick prototypes.

Advanced Template

A production-ready structure with:

• Organized route modules
• Authentication guards
• Type definitions
• Environment variables
• API examples with CRUD operations

Ideal for larger applications requiring scalability.

CRUD Template

Complete CRUD application with:

• SQLite database integration
• Employee management API
• Repository pattern
• API key authentication
• Input validation
• Full CRUD operations (Create, Read, Update, Delete)
• Statistics endpoints

Perfect for learning database integration or building data management APIs.

Real-time Template

WebSocket-powered chat application with:

• User registration & login
• JWT authentication
• Real-time messaging
• Typing indicators
• User presence tracking
• Beautiful web client
• Message persistence

Ideal for building chat apps, live notifications, or real-time collaboration tools.

Full-stack Template

Complete full-stack application combining:

• REST API endpoints
• WebSocket real-time features
• User authentication (JWT)
• Database persistence (SQLite)
• Modern responsive frontend
• Complete chat system

Best choice for full-featured applications requiring both REST and real-time capabilities.

What's Included

All templates include:

• ⚡ Bun-optimized configuration
• 📝 TypeScript setup with strict mode
• 🔒 Security defaults (HSTS, XSS protection, rate limiting)
• 🎯 Hot reload in development
• 🛠️ Pre-configured scripts

Requirements

• Bun 1.2.3 or higher

After Creation

cd my-app
bun run dev

Your server will start on http://localhost:3000

Learn More

• Zoltraak Documentation
• Zoltraak GitHub

License

MIT