{"id":19241947,"url":"https://github.com/r8/shelf_flutter_asset","last_synced_at":"2026-05-06T01:36:16.819Z","repository":{"id":65421391,"uuid":"591758532","full_name":"r8/shelf_flutter_asset","owner":"r8","description":"A simple handler for the Shelf ecosystem to serve files from Flutter assets.","archived":false,"fork":false,"pushed_at":"2023-07-04T13:39:10.000Z","size":104,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T19:54:42.402Z","etag":null,"topics":["dart","flutter","http","server","shelf"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/r8.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2023-01-21T19:17:49.000Z","updated_at":"2024-09-20T12:44:43.000Z","dependencies_parsed_at":"2023-02-13T01:16:29.004Z","dependency_job_id":null,"html_url":"https://github.com/r8/shelf_flutter_asset","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r8%2Fshelf_flutter_asset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r8%2Fshelf_flutter_asset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r8%2Fshelf_flutter_asset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r8%2Fshelf_flutter_asset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/r8","download_url":"https://codeload.github.com/r8/shelf_flutter_asset/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240331321,"owners_count":19784644,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dart","flutter","http","server","shelf"],"created_at":"2024-11-09T17:12:59.949Z","updated_at":"2025-10-19T22:51:18.782Z","avatar_url":"https://github.com/r8.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# shelf_flutter_asset\n\n[![build status](https://github.com/r8/shelf_flutter_asset/workflows/tests/badge.svg)](https://github.com/r8/shelf_flutter_asset/actions)\n[![codecov](https://codecov.io/gh/r8/shelf_flutter_asset/branch/main/graph/badge.svg?token=DXWQ52MGBI)](https://codecov.io/gh/r8/shelf_flutter_asset)\n[![pub package](https://img.shields.io/pub/v/shelf_flutter_asset.svg)](https://pub.dev/packages/shelf_flutter_asset)\n[![package publisher](https://img.shields.io/pub/publisher/shelf_flutter_asset.svg)](https://pub.dev/packages/shelf_flutter_asset/publisher)\n\nA simple handler for the Shelf ecosystem to serve files from Flutter assets.\n\n## Features\n\n- Serves files from Flutter assets\n- Support for default documents (like index.html)\n- Content type detection\n- Optional caching support with customizable max-age\n- Support for HTTP range requests\n- Support for conditional requests with If-Modified-Since\n\n## Usage\n\nBind as root handler:\n\n```dart\nimport 'package:shelf/shelf_io.dart' as io;\nimport 'package:shelf_flutter_asset/shelf_flutter_asset.dart';\n\nvoid main() {\n  var assetHandler = createAssetHandler(defaultDocument: 'index.html');\n\n  io.serve(assetHandler, 'localhost', 8080);\n}\n```\n\nBind with [`shelf_router`](https://pub.dev/packages/shelf_router):\n\n```dart\nimport 'package:shelf_router/shelf_router.dart';\nimport 'package:shelf/shelf.dart';\nimport 'package:shelf/shelf_io.dart' as io;\n\nvoid main() {\n  var app = Router();\n  final assetHandler = createAssetHandler();\n\n  app.get('/hello', (Request request) {\n    return Response.ok('hello-world');\n  });\n\n  app.get('/assets/\u003cignored|.*\u003e', (Request request) {\n    return assetHandler(request.change(path: 'assets'));\n  });\n\n  io.serve(app, 'localhost', 8080);\n}\n```\n\nBind with [`shelf_router`](https://pub.dev/packages/shelf_router) and custom root path:\n\n```dart\nimport 'package:shelf_router/shelf_router.dart';\nimport 'package:shelf/shelf.dart';\nimport 'package:shelf/shelf_io.dart' as io;\n\nvoid main() {\n  var app = Router();\n  final assetHandler = createAssetHandler(rootPath: 'assets/html');\n\n  app.get('/hello', (Request request) {\n    return Response.ok('hello-world');\n  });\n\n  app.get('/assets/\u003cignored|.*\u003e', (Request request) {\n    return assetHandler(request.change(path: 'assets/html'));\n  });\n\n  io.serve(app, 'localhost', 8080);\n}\n```\n\n## Advanced Usage\n\n### Caching\n\nEnable browser caching for better performance:\n\n```dart\nimport 'package:shelf/shelf_io.dart' as io;\nimport 'package:shelf_flutter_asset/shelf_flutter_asset.dart';\n\nvoid main() {\n  var assetHandler = createAssetHandler(\n    defaultDocument: 'index.html',\n    enableCaching: true,    // Enable caching\n    maxAge: 3600,           // Cache for 1 hour (in seconds)\n  );\n\n  io.serve(assetHandler, 'localhost', 8080);\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr8%2Fshelf_flutter_asset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fr8%2Fshelf_flutter_asset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr8%2Fshelf_flutter_asset/lists"}