Aqueduct

Build Status codecov

Gitter

Aqueduct is a server-side framework for building and deploying multi-threaded REST applications. It is written in Dart and targets the Dart VM. Its goal is to provide an integrated, consistently styled API. If this is your first time viewing Aqueduct, check out the tour.

The framework contains behavior for routing, OAuth 2.0, a PostgreSQL ORM, testing, and more.

The aqueduct command-line tool serves applications, manages database schemas and OAuth 2.0 clients, and generates OpenAPI specifications.

In-depth documentation is available here.

Getting Started

  1. Install Dart.

  2. Activate Aqueduct

     pub global activate aqueduct
    
  3. Create a new project.

     aqueduct create my_project
    

Open the project directory in an IntelliJ IDE, Atom or Visual Studio Code. All three IDEs have a Dart plugin.

Tutorials, Documentation and Examples

Step-by-step tutorials for beginners are available here.

You can find the API reference here or you can install it in Dash.

You can find in-depth and conceptual guides here.

An ever-expanding repository of Aqueduct examples is here.

Libraries

aqueduct

Core libraries for Aqueduct applications.

aqueduct.executable

aqueduct.managed_auth

Library for implementing OAuth 2.0 storage using ManagedObjects.

aqueduct.test

Testing utilities for Aqueduct applications