The Protevus Platform: Unified Full-Stack Development
https://protevus.com
lib | ||
test | ||
.gitignore | ||
.travis.yml | ||
LICENSE | ||
pubspec.yaml | ||
README.md |
angel_static
Static server middleware for Angel.
Installation
In pubspec.yaml
:
dependencies:
angel_framework: ^1.0.0-dev
angel_static: ^1.1.0-dev
Usage
To serve files from a directory, your app needs to have a
VirtualDirectory
mounted on it.
import 'dart:io';
import 'package:angel_framework/angel_framework.dart';
import 'package:angel_static/angel_static.dart';
main() async {
final app = new Angel();
await app.configure(new VirtualDirectory(source: new Directory('./public')));
await app.startServer();
}
Options
The VirtualDirectory
API accepts a few named parameters:
- source: A
Directory
containing the files to be served. If left null, then Angel will serve either fromweb
(in development) orbuild/web
(in production), depending on yourANGEL_ENV
. - indexFileNames: A
List<String>
of filenames that should be served as index pages. Default is['index.html']
. - publicPath: 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.
- debug: Print verbose debug output.