Search packages, repositories and app categories

Package detailsv2.0.0

relic

A lightweight and flexible web server inspired by Shelf for building APIs and backend services.

AndroidiOSmacOSWindowsLinux
30-day downloads
228K
Likes
119
Pub points
160

Install package

flutter pub add relic

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

Relic is a lightweight and flexible web server for Dart, inspired by Shelf, designed for building APIs and backend services. It provides a simple, modular approach to handling HTTP requests and responses, making it ideal for developers seeking performance and ease of use across multiple platforms. With support for Android, iOS, macOS, Windows, and Linux, Relic enables seamless backend development within Flutter applications or standalone services. Its minimal footprint and clean API allow rapid prototyping and scalable deployment.

Use cases

  • Building RESTful APIs
  • Creating backend services for Flutter apps
  • Developing cross-platform server-side logic
  • Prototyping microservices
  • Handling HTTP request routing

Key features

  • Lightweight and fast
  • Modular middleware support
  • Cross-platform compatibility
  • Simple and intuitive API
  • Built-in request/response handling

Suitable for

  • Flutter developers needing backend functionality
  • Teams building microservices
  • Solo developers prototyping APIs
  • Projects requiring server-side logic on multiple platforms
  • Applications with low-latency requirements

Considerations

  • Not suitable for high-concurrency production workloads without additional scaling
  • Limited built-in authentication compared to full frameworks
  • Requires manual setup for database integration
  • Best suited for small to medium-scale applications
  • No built-in WebSocket support in core package

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Relic web server banner

build codecov Stars on Github License: BSD-3-Clause

Relic web server

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.

👉 Full documentation available here 📚

Why Relic?

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. These are some of the improvements:

  • Strongly typed APIs with validated HTTP headers.
  • Simplified interface for setting up routing and middleware.
  • Unified encoding model for HTTP bodies.
  • Built-in trie-based router, which improves performance.
  • Static file handling with support for cache busting and etags.
  • Built-in support for WebSockets.
  • Improvements in hot reload and running with multiple isolates.

Quick start

  1. Install Dart 3.7 or newer and verify with dart --version.
  2. Add Relic: dart pub add relic
  3. Create a new console app and drop in the hello world server below.
dart create -t console-full hello_world
cd hello_world
dart pub add relic
Run your first Relic server

Place this file in bin/hello_world.dart (runnable example is also under example/example.dart):

import 'package:relic/io_adapter.dart';
import 'package:relic/relic.dart';

/// A simple 'Hello World' server demonstrating basic Relic usage.
Future<void> main() async {
  // Setup the app.
  final app =
      RelicApp()
        // Route with parameters (:name & :age).
        ..get('/user/:name/age/:age', helloHandler)
        // Middleware on all paths below '/'.
        ..use('/', logRequests())
        // Custom fallback - optional (default is 404 Not Found).
        ..fallback = respondWith(
          (_) => Response.notFound(
            body: Body.fromString("Sorry, that doesn't compute.\n"),
          ),
        );

  // Start the server (defaults to using port 8080).
  await app.serve();
}

const _ageParam = PathParam<int>(#age, int.parse);
/// Handles requests to the hello endpoint with path parameters.
Response helloHandler(final Request req) {
  final name = req.pathParameters.raw[#name];
  final age = req.pathParameters.get(_ageParam);

  return Response.ok(
    body: Body.fromString('Hello, $name! To think you are $age years old.\n'),
  );
}

Run it with dart run bin/hello_world.dart and visit http://localhost:8080/user/Nova/age/27.

Additional examples

Relic comes with an extensive set of examples. To run them, clone the Relic repository from GitHub and navigate to the example directory.

git clone https://github.com/serverpod/relic.git
cd relic/example
dart example.dart

Migrating from Shelf

Are you on Shelf? Moving over is straightforward. Relic's APIs are very similar while giving you typed requests, built-in routing, and WebSockets out of the box. Follow the step-by-step guide at docs.dartrelic.dev/getting-started/shelf-migration to upgrade your project in minutes.

Categories

Dependencies

Dependency list 2 items

  • relic_core^2.0.0
  • relic_io^2.0.0

Source repository

Projects using this package

No data available yet.