Examples

Examples & Tutorials

Discover real-world examples and step-by-step tutorials that demonstrate how to build applications with Veloce-TS.

🎯 Quick Start Examples

Hello World API

A simple “Hello World” API perfect for beginners to understand Veloce-TS basics.

Perfect for: Learning Veloce-TS fundamentals

Features demonstrated:

• ✅ Decorator-based routing
• ✅ Request validation with Zod
• ✅ Query parameter extraction
• ✅ Automatic OpenAPI documentation
• ✅ TypeScript support

TaskMaster - Task Management System

A comprehensive backend example showcasing all Veloce-TS features including authentication, RBAC, GraphQL, WebSockets, and more.

Perfect for: Understanding the complete framework capabilities

Features demonstrated:

• ✅ Decorator-based routing
• ✅ JWT Authentication & RBAC
• ✅ SQLite integration
• ✅ GraphQL support
• ✅ WebSocket handlers
• ✅ Custom middleware
• ✅ OpenAPI documentation

System of Administration

A production-ready enterprise administration system demonstrating advanced real-world business logic with caching, audit trails, role-based access, and automatic inventory management.

Perfect for: Building production-ready enterprise applications

Features demonstrated:

• ✅ Multiple REST Controllers
• ✅ JWT Authentication with bcrypt
• ✅ PostgreSQL + Prisma ORM
• ✅ Redis caching with intelligent invalidation
• ✅ Role-Based Access Control (RBAC)
• ✅ Structured logging with Pino
• ✅ Health checks and monitoring
• ✅ OpenAPI/Swagger documentation

🏗️ Coming Soon

We’re working on more examples to help you get started:

Blog Platform

• Article management
• Comment system
• User authentication
• Content categorization
• Search functionality

Chat Application

• Real-time messaging
• User presence
• Room management
• Message history
• File sharing

Social Media API

• User profiles
• Posts and comments
• Following system
• Notifications
• Content moderation

📚 Tutorial Series

Beginner Series

1. Hello World API - Your first Veloce-TS application
2. Basic CRUD Operations - Building a simple todo API
3. Authentication Setup - Adding JWT authentication
4. Database Integration - Working with databases

Intermediate Series

1. Middleware Development - Creating custom middleware
2. GraphQL Integration - Building GraphQL APIs
3. WebSocket Implementation - Real-time features
4. Testing Strategies - Testing your applications

Advanced Series

1. Microservices Architecture - Building distributed systems
2. Performance Optimization - Scaling your applications
3. Security Best Practices - Securing your APIs
4. Deployment Strategies - Production deployment

🎨 Community Examples

Have you built something cool with Veloce-TS? We’d love to showcase it!

• Submit your example via GitHub Issues
• Share your project in our community
• Write a tutorial and we’ll feature it here

🛠️ Contributing Examples

Want to contribute an example? Here’s how:

1. Fork the repository
2. Create your example in the examples/ directory
3. Add documentation explaining your implementation
4. Submit a pull request

Example Requirements

• Clear, well-documented code
• README with setup instructions
• Demonstrates specific Veloce-TS features
• Includes sample data or demo users
• Follows our coding standards

📖 Learning Path

For Beginners

1. Start with Hello World to learn the basics
2. Follow the Getting Started Guide
3. Experiment with decorators and validation
4. Move to TaskMaster for advanced features

For Experienced Developers

1. Explore advanced features in TaskMaster
2. Dive into GraphQL and WebSockets
3. Learn about Dependency Injection
4. Implement custom plugins and middleware

🔗 Additional Resources

• Documentation - Complete framework documentation
• API Reference - Detailed API documentation
• GitHub Repository - Source code and issues
• NPM Package - Latest release

---

:::tip Ready to Start? Choose an example that matches your experience level and start building with Veloce-TS today! :::