https://github.com/rikulo/stream

Lightweight Dart web server. Features: request routing, filtering, template engine, WebSocket, MVC design pattern, and file-based static resources.
https://github.com/rikulo/stream

Last synced: 6 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/rikulo/stream
• Owner: rikulo
• License: apache-2.0
• Created: 2012-12-29T08:37:06.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-10-21T05:30:59.000Z (about 2 months ago)
• Last Synced: 2024-10-23T01:06:27.654Z (about 2 months ago)
• Language: Dart
• Homepage: https://quire.io
• Size: 1.29 MB
• Stars: 234
• Watchers: 19
• Forks: 20
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-dart - Stream - Lightweight web server with request routing, filtering, template engine, WebSocket, MVC design pattern, and file-based static resources (Libraries / Server Frameworks)
• awesome-dart - Rikulo Stream - Lightweight web server with request routing, filtering, template engine, WebSocket, MVC design pattern, and file-based static resources. (Server Frameworks)

README

        
# Stream

[Stream](https://github.com/rikulo/stream) is a Dart web server supporting request routing, filtering, template engine, WebSocket, MVC design pattern and file-based static resources.

* [Home](https://github.com/rikulo/stream)

* [API Reference](https://pub.dev/documentation/stream/latest/)

* [Discussion](https://stackoverflow.com/questions/tagged/rikulo)

* [Git Repository](https://github.com/rikulo/stream)

* [Issues](https://github.com/rikulo/stream/issues)

## Installation

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

    dependencies:

      stream:

## Usage

* Introduction

* Getting Started with Hello World

### 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](https://github.com/rikulo/stream/blob/master/example/hello-mvc/webapp/listView.rsp.html) and [this](https://github.com/rikulo/stream/blob/master/test/features/webapp/includerView.rsp.html)).

### 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 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](https://en.wikipedia.org/wiki/Command-line_interface) as follows:

    dart -c lib/rspc.dart -n dir1 dir2 file1 fire2...

A dart file is generated for each RSP file you gave. Fore more options, please run:

    dart -c lib/rspc.dart -h

## Notes to Contributors

### Fork Stream

If you'd like to contribute back to the core, you can [fork this repository](https://help.github.com/articles/fork-a-repo) 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](https://help.github.com/) first.

## Who Uses

* [Quire](https://quire.io) - a simple, collaborative, multi-level task management tool.

* [Keikai](https://keikai.io) - a sophisticated spreadsheet for big data

* [Ottava](https://ottava.io) - a no-code SaaS platform simplifying data management, chart creation, and data analysis.