https://github.com/r8/shelf_flutter_asset

A simple handler for the Shelf ecosystem to serve files from Flutter assets.
https://github.com/r8/shelf_flutter_asset

dart flutter http server shelf

Last synced: 4 months ago
JSON representation

A simple handler for the Shelf ecosystem to serve files from Flutter assets.

• Host: GitHub
• URL: https://github.com/r8/shelf_flutter_asset
• Owner: r8
• License: bsd-3-clause
• Created: 2023-01-21T19:17:49.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-04T13:39:10.000Z (over 2 years ago)
• Last Synced: 2025-02-15T19:54:42.402Z (12 months ago)
• Topics: dart, flutter, http, server, shelf
• Language: Dart
• Homepage:
• Size: 102 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# shelf_flutter_asset

[![build status](https://github.com/r8/shelf_flutter_asset/workflows/tests/badge.svg)](https://github.com/r8/shelf_flutter_asset/actions)

[![codecov](https://codecov.io/gh/r8/shelf_flutter_asset/branch/main/graph/badge.svg?token=DXWQ52MGBI)](https://codecov.io/gh/r8/shelf_flutter_asset)

[![pub package](https://img.shields.io/pub/v/shelf_flutter_asset.svg)](https://pub.dev/packages/shelf_flutter_asset)

[![package publisher](https://img.shields.io/pub/publisher/shelf_flutter_asset.svg)](https://pub.dev/packages/shelf_flutter_asset/publisher)

A simple handler for the Shelf ecosystem to serve files from Flutter assets.

## Features

- Serves files from Flutter assets

- Support for default documents (like index.html)

- Content type detection

- Optional caching support with customizable max-age

- Support for HTTP range requests

- Support for conditional requests with If-Modified-Since

## Usage

Bind as root handler:

```dart

import 'package:shelf/shelf_io.dart' as io;

import 'package:shelf_flutter_asset/shelf_flutter_asset.dart';

void main() {

  var assetHandler = createAssetHandler(defaultDocument: 'index.html');

  io.serve(assetHandler, 'localhost', 8080);

}

```

Bind with [`shelf_router`](https://pub.dev/packages/shelf_router):

```dart

import 'package:shelf_router/shelf_router.dart';

import 'package:shelf/shelf.dart';

import 'package:shelf/shelf_io.dart' as io;

void main() {

  var app = Router();

  final assetHandler = createAssetHandler();

  app.get('/hello', (Request request) {

    return Response.ok('hello-world');

  });

  app.get('/assets/', (Request request) {

    return assetHandler(request.change(path: 'assets'));

  });

  io.serve(app, 'localhost', 8080);

}

```

Bind with [`shelf_router`](https://pub.dev/packages/shelf_router) and custom root path:

```dart

import 'package:shelf_router/shelf_router.dart';

import 'package:shelf/shelf.dart';

import 'package:shelf/shelf_io.dart' as io;

void main() {

  var app = Router();

  final assetHandler = createAssetHandler(rootPath: 'assets/html');

  app.get('/hello', (Request request) {

    return Response.ok('hello-world');

  });

  app.get('/assets/', (Request request) {

    return assetHandler(request.change(path: 'assets/html'));

  });

  io.serve(app, 'localhost', 8080);

}

```

## Advanced Usage

### Caching

Enable browser caching for better performance:

```dart

import 'package:shelf/shelf_io.dart' as io;

import 'package:shelf_flutter_asset/shelf_flutter_asset.dart';

void main() {

  var assetHandler = createAssetHandler(

    defaultDocument: 'index.html',

    enableCaching: true,    // Enable caching

    maxAge: 3600,           // Cache for 1 hour (in seconds)

  );

  io.serve(assetHandler, 'localhost', 8080);

}

```