107 lines
3.5 KiB
Markdown
107 lines
3.5 KiB
Markdown
[](https://angel-dart.dev)
|
|
|
|
[](https://gitter.im/angel_dart/discussion)
|
|
[](https://pub.dartlang.org/packages/angel_framework)
|
|
[](https://travis-ci.org/angel-dart/framework)
|
|
|
|
|
|
**A polished, production-ready backend framework in Dart.**
|
|
|
|
-----
|
|
## 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.
|
|
|
|
With features like the following, Angel is the all-in-one framework you should choose to build your next project:
|
|
* GraphQL Support
|
|
* PostgreSQL ORM
|
|
* Dependency Injection
|
|
* Static File Handling
|
|
* And much more...
|
|
|
|
See all the packages in the `packages/` directory.
|
|
|
|
## IMPORTANT NOTES
|
|
This is a port of Angel Framework to work with Dart 2.10.x and above. Dart version below 2.10.x is not supported.
|
|
|
|
Branch: master
|
|
- Stable version of sdk-2.12.x branch
|
|
|
|
Branch: sdk-2.10.x
|
|
- Support dart 2.10.x only. Use sdk: ">=2.10.0 <2.12.0"
|
|
- Status: Migration completed. Not all plugin packages are tested.
|
|
|
|
Branch: sdk-2.12.x
|
|
- Support dart 2.12.x. Use sdk: ">=2.10.0 <3.0.0"
|
|
- Do not support NNBD
|
|
- Status: Basic and ORM templates are working with the core plugins migration completed. The remaining add on plugin packages are work in progress.
|
|
|
|
Branch: sdk-2.12.x-nnbd
|
|
- Support dart 2.12.x. Use sdk: ">=2.12.0 <3.0.0"
|
|
- Support NNBD
|
|
- Status: Not working yet. To be available once all the dependency libraries that support NNBD are released
|
|
|
|
Changes involved:
|
|
- Upgraded dependency libraries and fixed the deprecated API
|
|
|
|
Deprecated features:
|
|
- None
|
|
|
|
New features:
|
|
- To be decided
|
|
|
|
To install Angel CLI, run the following command after installing dart sdk
|
|
|
|
`dart pub global activate --source git https://github.com/dukefirehawk/angel/packages/cli`
|
|
|
|
To use local development version of Angel CLI, run the following command after installing dart sdk
|
|
|
|
`dart pub global activate --source path ./packages/cli`
|
|
|
|
|
|
## Installation & Setup
|
|
|
|
Once you have [Dart](https://www.dartlang.org/) installed, bootstrapping a project is as simple as running a few shell commands:
|
|
|
|
Install the [Angel CLI](https://github.com/angel-dart/cli):
|
|
|
|
```bash
|
|
pub global activate angel_cli
|
|
```
|
|
|
|
Bootstrap a project:
|
|
|
|
```bash
|
|
angel init hello
|
|
```
|
|
|
|
You can even have your server run and be *hot-reloaded* on file changes:
|
|
|
|
```bash
|
|
dart --observe bin/dev.dart
|
|
```
|
|
|
|
Next, check out the [detailed documentation](https://docs.angel-dart.dev/v/2.x) to learn to flesh out your project.
|
|
|
|
## Development
|
|
|
|
* Install development version of Angel CLI
|
|
`dart pub global activate --source path ./packages/cli`
|
|
`dart pub global activate --source git https://github.com/dukefirehawk/angel/packages/cli`
|
|
|
|
## 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).
|
|
|
|
There is also an [Awesome Angel :fire:](https://github.com/angel-dart/awesome-angel) list.
|
|
|
|
## Contributing
|
|
Interested in contributing to Angel? Start by reading the contribution guide [here](CONTRIBUTING.md).
|