Deserve

Build HTTP server effortlessly with zero configuration for productivity.

Installation

Install Deno 2.5.4+ and run deno init for new projects.

Add Deserve using the deno add command:

deno add jsr:@neabyte/deserve

Follow our installing guide for more information.

Table of Contents

• Getting Started

  • Installation - Set up Deserve in your project
  • Quick Start - Create your first API in minutes
  • Server Configuration - Server setup and shutdown
  • Routes Configuration - Configure router options

• Core Concepts

  • Philosophy - Framework design principles
  • File-based Routing - How file structure becomes API endpoints
  • Route Patterns - Dynamic routes and parameter matching
  • Context Object - Request context wrapper with convenient methods
  • Request Handling - Enhanced request object with automatic parsing

• Middleware

  • Use Global - Cross-cutting functionality
  • Use Route-Specific - Targeted middleware for specific routes
  • Basic Auth - HTTP Basic Authentication
  • CORS - Cross-origin request handling
  • WebSocket - Real-time bidirectional communication

• Response Utilities

  • JSON Format - Create JSON responses easily
  • Text Format - Plain text responses
  • HTML Format - HTML content responses
  • File Downloads - Download files from filesystem
  • Data Downloads - Download in-memory content
  • Redirects - Redirect responses
  • Custom Responses - Full control over response options

• Static Files

  • Basic Static Serving - Serve static files from directories
  • Multiple Directories - Serve from multiple locations

• Error Handling

  • Default Behavior - Automatic error handling
  • Object Details - Detailed error information

Contributing

Help us make Deserve even simpler! Every contribution helps make building APIs effortless.

How to Contribute

• Report Bugs - Found something broken? Let us know via GitHub Issues
• Suggest Features - Have an idea that aligns with our simplicity-first philosophy? Create an issue
• Fix & Improve - Submit Pull Requests for bug fixes, typos, or code improvements
• Build Middleware - Create and share third-party middleware that extends Deserve's capabilities
• Improve Docs - Help us make the documentation clearer (supports English and Indonesian!)
• Use Deserve - The best contribution? Use it in your projects and share your feedback

License

This project is licensed under the MIT license. See the LICENSE file for more info.