2019-04-18 16:18:39 +00:00
|
|
|
[](https://angel-dart.dev)
|
2016-12-27 14:28:48 +00:00
|
|
|
|
2017-02-02 20:48:25 +00:00
|
|
|
[](https://gitter.im/angel_dart/discussion)
|
2017-10-19 21:53:33 +00:00
|
|
|
[](https://pub.dartlang.org/packages/angel_framework)
|
2018-06-05 23:51:20 +00:00
|
|
|
[](https://travis-ci.org/angel-dart/framework)
|
|
|
|
|
|
2016-12-21 20:34:04 +00:00
|
|
|
|
2019-04-18 16:18:39 +00:00
|
|
|
**A polished, production-ready backend framework in Dart.**
|
2018-12-11 03:36:14 +00:00
|
|
|
|
|
|
|
|
-----
|
2019-04-18 16:18:39 +00:00
|
|
|
## About
|
|
|
|
|
Angel is a full-stack Web framework in Dart. It aims to
|
|
|
|
|
streamline development by providing many common features
|
|
|
|
|
out-of-the-box in a consistent manner.
|
2019-10-03 01:21:08 +00:00
|
|
|
We are an application boilerplate and not the underlying framework library.
|
|
|
|
|
|
2017-05-05 22:02:48 +00:00
|
|
|
|
2019-04-18 16:18:39 +00:00
|
|
|
With features like the following, Angel is the all-in-one framework you should choose to build your next project:
|
|
|
|
|
* [GraphQL Support](https://github.com/angel-dart/graphql)
|
|
|
|
|
* [PostgreSQL ORM](https://github.com/angel-dart/orm)
|
|
|
|
|
* [Dependency Injection](https://docs.angel-dart.dev/guides/dependency-injection)
|
|
|
|
|
* And [much more](https://github.com/angel-dart)...
|
2017-06-05 17:01:45 +00:00
|
|
|
|
2017-03-23 11:23:16 +00:00
|
|
|
## Installation & Setup
|
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
|
|
|
```
|
|
|
|
|
|
2019-04-18 16:18:39 +00:00
|
|
|
Next, check out the [detailed documentation](https://docs.angel-dart.dev/v/2.x) to learn to flesh out your project.
|
2017-04-02 20:32:03 +00:00
|
|
|
|
2019-04-18 16:18:39 +00:00
|
|
|
## Examples and Documentation
|
|
|
|
|
Visit the [documentation](https://docs.angel-dart.dev/v/2.x)
|
|
|
|
|
for dozens of guides and resources, including video tutorials,
|
|
|
|
|
to get up and running as quickly as possible with Angel.
|
|
|
|
|
|
|
|
|
|
Examples and complete projects can be found
|
|
|
|
|
[here](https://github.com/angel-dart/examples-v2).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can also view the [API Documentation](http://www.dartdocs.org/documentation/angel_framework/latest).
|
2017-04-02 20:32:03 +00:00
|
|
|
|
2019-04-18 16:18:39 +00:00
|
|
|
There is also an [Awesome Angel :fire:](https://github.com/angel-dart/awesome-angel) list.
|
2018-12-11 03:36:14 +00:00
|
|
|
|
