2018-07-15 04:24:42 +00:00
|
|
|
[![The Angel Framework](https://angel-dart.github.io/assets/images/logo.png)](https://angel-dart.github.io)
|
2016-12-27 14:28:48 +00:00
|
|
|
|
2017-02-02 20:48:25 +00:00
|
|
|
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/angel_dart/discussion)
|
2017-10-19 21:53:33 +00:00
|
|
|
[![Pub](https://img.shields.io/pub/v/angel_framework.svg)](https://pub.dartlang.org/packages/angel_framework)
|
2018-06-05 23:51:20 +00:00
|
|
|
[![Build status](https://travis-ci.org/angel-dart/framework.svg?branch=master)](https://travis-ci.org/angel-dart/framework)
|
|
|
|
![License](https://img.shields.io/github/license/angel-dart/framework.svg)
|
2016-12-21 20:34:04 +00:00
|
|
|
|
2018-12-11 03:36:14 +00:00
|
|
|
**A batteries-included, full-stack Web server framework for Dart.**
|
|
|
|
|
|
|
|
-----
|
2017-05-05 22:02:48 +00:00
|
|
|
|
2017-04-02 20:32:44 +00:00
|
|
|
[Wiki (in-depth documentation)](https://github.com/angel-dart/angel/wiki)
|
2016-06-21 23:39:09 +00:00
|
|
|
|
2019-02-03 06:04:35 +00:00
|
|
|
[API Documentation](http://www.dartdocs.org/documentation/angel_framework/latest)
|
2016-12-21 19:41:23 +00:00
|
|
|
|
|
|
|
[Roadmap](https://github.com/angel-dart/roadmap/blob/master/ROADMAP.md)
|
|
|
|
|
|
|
|
[File an Issue](https://github.com/angel-dart/roadmap/issues)
|
2017-03-11 03:40:14 +00:00
|
|
|
|
2017-06-13 00:55:20 +00:00
|
|
|
[Awesome Angel :fire:](https://github.com/angel-dart/awesome-angel)
|
|
|
|
|
2017-04-02 20:36:48 +00:00
|
|
|
|
|
|
|
|
2018-12-11 03:36:14 +00:00
|
|
|
Like what you see? Please lend us a star! :star:
|
2017-04-02 21:08:10 +00:00
|
|
|
|
2017-06-05 17:01:45 +00:00
|
|
|
## Newest Tutorials
|
2018-12-11 03:36:14 +00:00
|
|
|
* [Dependency Injection Patterns with Angel 2](https://thosakwe.com/dependency-injection-patterns-in-angel-2/)
|
|
|
|
* [Angel 2.0.0 is Almost Here - What it Means for You](https://thosakwe.com/new-features-coming-to-angel-in-version-2-0-0/)
|
|
|
|
* [GraphQL is coming to Angel (and Dart)](https://thosakwe.com/graphql-is-coming-to-angel-and-dart/)
|
2017-06-05 17:01:45 +00:00
|
|
|
|
2017-03-23 11:23:16 +00:00
|
|
|
## Installation & Setup
|
2018-12-11 03:36:14 +00:00
|
|
|
*Having errors with a fresh Angel installation? See [here](https://angel-dart.gitbook.io/angel/the-basics/installation) for help.*
|
2017-04-02 20:32:03 +00:00
|
|
|
|
2018-12-11 03:36:14 +00:00
|
|
|
Once you have [Dart](https://www.dartlang.org/) installed, bootstrapping a project is as simple as running a few shell commands:
|
2017-04-02 20:28:22 +00:00
|
|
|
|
2017-04-02 20:32:03 +00:00
|
|
|
Install the [Angel CLI](https://github.com/angel-dart/cli):
|
2017-04-02 20:28:22 +00:00
|
|
|
|
|
|
|
```bash
|
|
|
|
pub global activate angel_cli
|
2017-04-02 20:32:03 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
Bootstrap a project:
|
|
|
|
|
|
|
|
```bash
|
2017-04-02 20:28:22 +00:00
|
|
|
angel init hello
|
|
|
|
```
|
2017-04-02 20:32:03 +00:00
|
|
|
|
2018-12-11 03:36:14 +00:00
|
|
|
You can even have your server run and be *hot-reloaded* on file changes:
|
2017-04-02 20:38:20 +00:00
|
|
|
|
2017-06-10 15:45:59 +00:00
|
|
|
```bash
|
2018-12-11 03:36:14 +00:00
|
|
|
dart --observe bin/dev.dart
|
2017-04-02 20:38:20 +00:00
|
|
|
```
|
|
|
|
|
2018-12-11 03:36:14 +00:00
|
|
|
Next, check out the [detailed documentation](https://angel-dart.gitbook.io/angel) to learn to flesh out your project.
|
2017-04-02 20:32:03 +00:00
|
|
|
|
2017-04-02 20:59:58 +00:00
|
|
|
## Features
|
|
|
|
With features like the following, Angel is the all-in-one framework you should choose to build your next project:
|
|
|
|
* [Advanced, Modular Routing](https://github.com/angel-dart/route)
|
2018-12-11 03:36:14 +00:00
|
|
|
* [Middleware](https://angel-dart.gitbook.io/angel/the-basics/middleware)
|
|
|
|
* [Dependency Injection](https://angel-dart.gitbook.io/angel/the-basics/dependency-injection)
|
2017-07-14 12:41:54 +00:00
|
|
|
* [Strongly-typed ORM](https://github.com/angel-dart/orm)
|
2017-04-02 20:59:58 +00:00
|
|
|
* And [much more](https://github.com/angel-dart)...
|
2017-04-02 20:32:03 +00:00
|
|
|
|
2017-04-02 20:59:58 +00:00
|
|
|
## Basic Example
|
2018-12-11 03:36:14 +00:00
|
|
|
Examples and complete projects can be found here:
|
|
|
|
|
|
|
|
https://github.com/angel-dart/examples-v2
|