astra 1.0.0-dev.86

Astra is a Shelf web server implementation with multi-threaded support and hot reload.

Astra is a Shelf web server implementation with multi-threaded support and hot reload.

WORK IN PROGRESS

ToDo:

• Errors, error handling and verbose output (here)
• Environment variables
• Tests
• More API Documentation
• Logging
• Manual hot reload (r) & hot restart (R)
• Middlewares:
  • ...
• build_runner integration
• ...
• Tutorials, Cookbook, ...
• Replace HttpServer with Shelf Request/Response first server implementation (experimenting)

Quickstart

Install using dart pub:

$ dart pub global activate astra

Create an application, in lib/[package].dart:

import 'dart:io';

import 'package:astra/core.dart';

Response application(Request request) {
  return Response.ok('hello world!');
}

Run the server:

$ astra serve

Usage

The astra command line tool is the easiest way to run your application...

Command line options

$ astra serve -h
Serve application.

Usage: astra serve [arguments]
-h, --help                           Print this usage information.

Common options:
-d, --directory=<path>               Run this in the directory.
-v, --verbose                        Output more informational messages.

Application options:
-t, --target=<name>                  Application target.
                                     (defaults to "application")
-j, --concurrency=<count>            Number of isolates.
                                     (defaults to "1")

Server options:
-a, --address=<internet-address>     Bind socket to this address.
                                     (defaults to "localhost")
-p, --port=<port>                    Bind socket to this port.
                                     (defaults to "3000")
    --backlog=<count>                Maximum number of connections to hold in backlog.
                                     (defaults to "0")
    --shared                         Socket connections distributing.
    --v6Only                         Restrict socket to version 6.
    --ssl-cert=<path>                SSL certificate file.
    --ssl-key=<path>                 SSL key file.
    --ssl-key-password=<password>    SSL key file password.

Debugging options:
-r, --reload                         Enable hot-reload.
-o, --observe=<port>                 Enable VM Observer.
                                     (defaults to "3001")

Run "astra help" to see global options.

Running programmatically

To run server directly from your application:

bin/main.dart

import 'package:astra/serve.dart';
import 'package:example/example.dart';

Future<void> main() async {
  var server = await serve(application, 'localhost', 3000);
  print('serving at ${server.url}');
}

Application target

The --target option allows loading the application with different name and different types.

Handler function:

// astra serve -t echo

Response echo(Request request) {
  return Response.ok('hello world!');
}

Application instance:

$ astra serve --target example

const Example example = Example();

class Example extends Application {
  // ...
}

Not yet:

• Application class
• Application or Handler factory
• Handler like callable class, instance and factory
• package uri