The Protevus Platform: Unified Full-Stack Development https://protevus.com
Find a file
2016-11-23 04:41:41 -05:00
lib 1.0.0 2016-05-02 19:11:25 -04:00
test Rename all_tests.dart to all_test.dart 2016-11-23 04:41:41 -05:00
.gitignore First commit 2016-04-21 17:27:22 -04:00
.travis.yml Create .travis.yml 2016-11-23 04:35:47 -05:00
LICENSE Initial commit 2016-04-21 17:29:34 -04:00
pubspec.yaml Updated Angel dep 2016-06-21 19:18:12 -04:00
README.md Update README.md 2016-11-23 04:37:28 -05:00

angel_static

version 1.0.1 build status

Static server middleware for Angel.

Installation

In pubspec.yaml:

dependencies:
    angel_framework: ^1.0.0-dev
    angel_static: ^1.0.0

Usage

As with all Angel middleware, this can be used simply via a function call within the route declaration, or registered under a name and invoked under that same name.

import 'dart:io';
import 'package:angel_framework/angel_framework.dart';
import 'package:angel_static/angel_static.dart';

main() async {
    Angel angel = new Angel();
    angel.registerMiddleware("static", serveStatic());
    angel.get('/virtual*', serveStatic(virtualRoot: '/virtual'));
    angel.get("*", "static");

    await angel.startServer(InternetAddress.LOOPBACK_IP_V4, 8080);
}

Options

serveStatic accepts two named parameters.

  • sourceDirectory: A Directory containing the files to be served. If left null, then Angel will serve either from web (in development) or build/web (in production), depending on your ANGEL_ENV.
  • indexFileNames: A List<String of filenames that should be served as index pages. Default is ['index.html'].
  • virtualRoot: To serve index files, you need to specify the virtual path under which angel_static is serving your files. If you are not serving static files at the site root, please include this.