2021-06-11 04:00:10 +00:00
|
|
|
[](https://github.com/dukefirehawk/boilerplates/blob/angel3-orm)
|
|
|
|
|
[](https://pub.dartlang.org/packages/angel3_framework)
|
|
|
|
|
[](https://dart.dev/null-safety)
|
|
|
|
|
[](https://gitter.im/angel_dart/discussion)
|
2016-12-27 14:28:48 +00:00
|
|
|
|
2021-06-11 04:00:10 +00:00
|
|
|
[](https://github.com/dukefirehawk/boilerplates/blob/angel3-orm/LICENSE)
|
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-10-09 18:24:56 +00:00
|
|
|
*Note: This repo is an application boilerplate ,and not the underlying framework library.*
|
|
|
|
|
|
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
|
|
|
|
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:
|
2021-06-11 04:00:10 +00:00
|
|
|
* [GraphQL Support](https://github.com/dukefirehawk/angel/tree/master/packages/graphql)
|
|
|
|
|
* [PostgreSQL ORM](https://github.com/dukefirehawk/angel/tree/master/packages/orm)
|
|
|
|
|
* [Dependency Injection](https://angel3-docs.dukefirehawk.com/guides/dependency-injection)
|
|
|
|
|
* And [much more](https://github.com/dukefirehawk/angel)...
|
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
|
|
|
|
2021-06-11 04:00:10 +00:00
|
|
|
Once you have [Dart](https://dart.dev/get-dart) installed, bootstrapping a project is as simple as running a few shell commands:
|
2017-04-02 20:28:22 +00:00
|
|
|
|
2021-06-11 04:00:10 +00:00
|
|
|
Install the [Angel3 CLI](https://github.com/dukefirehawk/angel3-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
|
|
|
```
|
|
|
|
|
|
2021-06-11 04:00:10 +00:00
|
|
|
Next, check out the [detailed documentation](https://angel3-docs.dukefirehawk.com/guides) 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
|
2021-06-11 04:00:10 +00:00
|
|
|
Visit the [documentation](https://angel3-docs.dukefirehawk.com/guides)
|
2019-04-18 16:18:39 +00:00
|
|
|
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
|
2021-06-11 04:00:10 +00:00
|
|
|
[here](https://github.com/dukefirehawk/angel3-examples/tree/master/docs_examples/getting_started).
|
2019-04-18 16:18:39 +00:00
|
|
|
|
|
|
|
|
|
2021-06-11 04:00:10 +00:00
|
|
|
You can also view the [API Documentation](https://pub.dev/documentation/angel3_framework/latest/).
|
2017-04-02 20:32:03 +00:00
|
|
|
|
2021-06-11 04:00:10 +00:00
|
|
|
There is also an [Awesome Angel :fire:](https://github.com/dukefirehawk/angel3-awesome) list.
|
2018-12-11 03:36:14 +00:00
|
|
|
|
