2021-05-16 10:37:27 +00:00
[![Angel 3 Framework ](./logo3.png )]
<!-- - (https://angel - dart.dev) -->
[![version ](https://img.shields.io/badge/pub-v4.0.0-brightgreen )](https://pub.dartlang.org/packages/framework)
[![Null Safety ](https://img.shields.io/badge/null-safety-brightgreen )](https://dart.dev/null-safety)
[![Gitter ](https://img.shields.io/gitter/room/nwjs/nw.js.svg )](https://gitter.im/angel_dart/discussion)
[![License ](https://img.shields.io/github/license/dukefirehawk/angel )](https://github.com/dukefirehawk/angel/LICENSE)
<!-- -
2019-04-18 16:18:39 +00:00
[![The Angel Framework ](https://angel-dart.github.io/assets/images/logo.png )](https://angel-dart.dev)
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 )
2021-05-16 10:37:27 +00:00
-->
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
2021-05-16 10:37:27 +00:00
Angel3 is a full-stack Web framework in Dart. It aims to
2019-04-18 16:18:39 +00:00
streamline development by providing many common features
out-of-the-box in a consistent manner.
2019-10-03 01:21:08 +00:00
2017-03-23 11:23:16 +00:00
## Installation & Setup
2017-04-02 20:32:03 +00:00
2021-05-16 10:37:27 +00:00
1. Download and install [Dart ](https://www.dartlang.org/ ).
2. Run the following command to start Angel3 server in dev mode to *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-05-16 10:37:27 +00:00
3. Next, check out the [detailed documentation ](https://docs.angel-dart.dev/v/2.x ) to learn to flesh out your project. Angel3 works the same way as the original Angel.
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