stream 1.2.0

Stream

Stream is a Dart web server supporting request routing, filtering, template engine, WebSocket, MVC design pattern and file-based static resources.

Stream is distributed under an Apache 2.0 License.

Build Status

Installation

Add this to your pubspec.yaml (or create it):

dependencies:
  stream:

Then run the Pub Package Manager (comes with the Dart SDK):

pub install

Usage

Compile RSP (Rikulo Stream Page) to dart files

There are two ways to compile RSP files into dart files: automatic building with Dart Editor or manual compiling.

RSP is a template technology allowing developers to create dynamically generated web pages based on HTML, XML or other document types (such as this and this). Please refer to here for more information.

Build with Dart Editor

To compile your RSP files automatically, you just need to add a build.dart file in the root directory of your project, with the following content:

import 'package:stream/rspc.dart';
void main(List<String> arguments) {
  build(arguments);
}

With this build.dart script, whenever your RSP is modified, it will be re-compiled.

Compile Manually

To compile a RSP file manually, run rspc (RSP compiler) to compile it into the dart file with command line interface as follows:

dart bin/rspc.dart your-rsp-file(s)

A dart file is generated for each RSP file you gave.

Notes to Contributors

Fork Stream

If you'd like to contribute back to the core, you can fork this repository and send us a pull request, when it is ready.

Please be aware that one of Stream's design goals is to keep the sphere of API as neat and consistency as possible. Strong enhancement always demands greater consensus.

If you are new to Git or GitHub, please read this guide first.

1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  stream: ">=1.2.0 <2.0.0"

If your package is an application package you should use any as the version constraint.

2. Install it

If you're using the Dart Editor, choose:

Menu > Tools > Pub Install

Or if you want to install from the command line, run:

$ pub install

3. Import it

Now in your Dart code, you can use:

import 'package:stream/stream.dart';

About

Lightweight Dart web server supporting request routing, filtering, template engine, MVC design pattern, and file-based static resources.

Author

Email tomyeh@rikulo.org Tom Yeh

Homepage

http://rikulo.org/projects/stream

Documentation

http://docs.rikulo.org/stream

Uploader

tomyeh@rikulo.org

Share