45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
|
|
[![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/angel3_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)
|
|
|
|
|
|
**A polished, production-ready backend framework in Dart.**
|
|
|
|
*Note: This repo is an application boilerplate ,and not the underlying framework library.*
|
|
|
|
-----
|
|
## About
|
|
Angel3 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.
|
|
|
|
## Installation & Setup
|
|
|
|
1. Download and install [Dart](https://dart.dev/get-dart).
|
|
2. Run the following command to start Angel3 server in dev mode to *hot-reloaded* on file changes:
|
|
|
|
```bash
|
|
dart --observe bin/dev.dart
|
|
```
|
|
|
|
3. Next, check out the [detailed documentation](https://angel3-docs.dukefirehawk.com/guides) to learn to flesh out your project. Angel3 works the same way as the original Angel.
|
|
|
|
## Examples and Documentation
|
|
Visit the [documentation](https://angel3-docs.dukefirehawk.com/guides)
|
|
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/dukefirehawk/angel3-examples).
|
|
|
|
|
|
You can also view the [API Documentation](https://pub.dev/documentation/angel3_framework/latest/).
|
|
|
|
There is also an [Awesome Angel :fire:](https://github.com/dukefirehawk/angel3-awesome) list.
|
|
|