{ "code": 200, "data": { "description": "Relic is a modern, high-performance web server framework inspired by Shelf and built by the Serverpod team to meet the demanding requirements of modern web applications. Relic provides a robust, type-safe, and efficient foundation for building scalable web services.", "external": { "alternate": { "https://docs.dartrelic.dev/": { "data-rh": "true", "hreflang": "x-default" } }, "canonical": { "https://docs.dartrelic.dev/": { "data-rh": "true" } }, "icon": { "https://docs.dartrelic.dev/img/favicon.png": { "data-rh": "true" } }, "preconnect": { "https://www.google-analytics.com/": {}, "https://www.googletagmanager.com/": {} }, "prefetch": { "https://docs.dartrelic.dev/assets/js/0ca634c5.c40e5698.js": {}, "https://docs.dartrelic.dev/assets/js/17896441.35fb8100.js": {}, "https://docs.dartrelic.dev/assets/js/22dd74f7.32b10889.js": {}, "https://docs.dartrelic.dev/assets/js/2c10348c.c38ae9dc.js": {}, "https://docs.dartrelic.dev/assets/js/2dc195cc.c7b109bb.js": {}, "https://docs.dartrelic.dev/assets/js/441e1055.6248ef14.js": {}, "https://docs.dartrelic.dev/assets/js/4edc808e.d18ceb40.js": {}, "https://docs.dartrelic.dev/assets/js/5b00fbf1.0fa3fba9.js": {}, "https://docs.dartrelic.dev/assets/js/5e95c892.753674ac.js": {}, "https://docs.dartrelic.dev/assets/js/6783a3b2.0aa1428a.js": {}, "https://docs.dartrelic.dev/assets/js/9412f430.c708638d.js": {}, "https://docs.dartrelic.dev/assets/js/9576f52c.f029d9c3.js": {}, "https://docs.dartrelic.dev/assets/js/a7bd4aaa.b870ce93.js": {}, "https://docs.dartrelic.dev/assets/js/a94703ab.055f41b9.js": {}, "https://docs.dartrelic.dev/assets/js/a9685393.8fdc4764.js": {}, "https://docs.dartrelic.dev/assets/js/aba21aa0.1d722264.js": {}, "https://docs.dartrelic.dev/assets/js/aca04f59.28672d9f.js": {}, "https://docs.dartrelic.dev/assets/js/b4e2adc5.e5a3b2b2.js": {}, "https://docs.dartrelic.dev/assets/js/b685e31b.f5eb8692.js": {}, "https://docs.dartrelic.dev/assets/js/be2b5817.53d9f078.js": {}, "https://docs.dartrelic.dev/assets/js/c644a7fe.ad3a69e0.js": {}, "https://docs.dartrelic.dev/assets/js/c678908c.c170f033.js": {} } }, "html": "\n\n\n🎯 Introduction | Relic\n\n\n\n\n\n\n\n\n\n\n
Skip to main content
Version: 1.0.0

Introduction

\n

Relic is a modern, high-performance web server framework inspired by Shelf and built by the Serverpod team to meet the demanding requirements of modern web applications. Relic provides a robust, type-safe, and efficient foundation for building scalable web services.

\n

Why Relic?​

\n

While Shelf has been a solid foundation for Dart web applications, several areas for improvement were identified. Rather than work around these limitations, Relic was created as a next-generation framework that maintains Shelf's familiar structure while delivering significant enhancements.

\n

Features​

\n

Relic aims to be a comprehensive web server framework for Dart. It provides a wide range of features out of the box and allows you to extend it with middleware. Here are some of the key features:

\n\n

🔒 Type Safe

Strongly typed APIs with validated HTTP headers.

⚡ Fast

High performance through trie-based routing and LRU caching.

🔌 WebSockets

Built-in WebSocket support for real time communication.

🔧 Middleware

Composable middleware pipeline with router integration.

👨‍💻 Dev Ready

Great IDE support, clear errors, and full documentation.

🚀 Production

Production-ready with high test coverage (3,000+ tests).

\n

Comparison with Shelf​

\n

Relic started out as a clone of Shelf, but has since diverged. An adapter is being built so that you can use Shelf middleware with Relic. Here is a comparison of some of the key differences:

\n
FeatureShelfRelic
Type Safety❌ Uses dynamic types✅ Strongly typed APIs with validated HTTP headers
Routing❌ Linear scan over routes✅ Built-in trie-based router
WebSockets❌ External packages✅ Built-in support
Performance✅ Good✅ Optimized (trie routing, LRU cache)
Path Parameters❌ String-based✅ Symbol-based
Static Files❌ Limited✅ Includes cache busting & etag support
Control Flow❌ Exceptions for control flow✅ Explicit state machine
Request State❌ Untyped context bag✅ Context properties with IDE discoverability
Body Model❌ Body and encoding are separate✅ Unified
\n\n", "metadata": { "description": "Relic is a modern, high-performance web server framework inspired by Shelf and built by the Serverpod team to meet the demanding requirements of modern web applications. Relic provides a robust, type-safe, and efficient foundation for building scalable web services.", "docsearch:docusaurus_tag": "docs-default-1.0.0", "docsearch:language": "en", "docsearch:version": "1.0.0", "docusaurus_locale": "en", "docusaurus_tag": "docs-default-1.0.0", "docusaurus_version": "1.0.0", "generator": "Docusaurus v3.9.2", "lang": "en", "og:description": "Relic is a modern, high-performance web server framework inspired by Shelf and built by the Serverpod team to meet the demanding requirements of modern web applications. Relic provides a robust, type-safe, and efficient foundation for building scalable web services.", "og:locale": "en", "og:title": "🎯 Introduction | Relic", "og:url": "https://docs.dartrelic.dev/", "twitter:card": "summary_large_image", "viewport": "width=device-width, initial-scale=1.0" }, "title": "🎯 Introduction | Relic", "url": "https://docs.dartrelic.dev/", "usage": { "tokens": 14117 } }, "meta": { "usage": { "tokens": 14117 } }, "status": 20000 }