6.5 KiB
Angel3 Framework
A polished, production-ready backend framework in Dart with NNBD support.
About
Angel3 originated from a fork of the archived Angel framework in support of Dart SDK 2.12.x or later. It is a full-stack Web framework in Dart that aims to streamline development by providing many common features out-of-the-box in a consistent manner. The codebase has been completely migrated and refactored to support null safety. One of the main goal is to enable developers to build both frontend and backend in the same language, Dart, with null safety. Angel3 is designed as a collection of plugins that enable developers to pick and choose the parts needed for their projects. A series of starter templates are also provided for quick start and trial run with Angel3. Visit our website to learn more.
The available features in Angel3 includes:
- Server-Side Rendering (Markdown, Mustache, Jinja, JAEL)
- OAuth2 Authentication
- WebSocket
- HTTP/2
- HTTP Streaming
- GraphQL
- ORM for PostgreSQL
- ORM for MySQL
- MongoDB
- Cache
See all of the available packages
for more information.
Important Notes
Angel3 packages are published under angel3_
prefix on pub.dev. These packages have passed all of their respective test suites before going live. The development work is ongoing in improving its features and performance for better development and deployment experience.
The status of the project is as follows:
Branch: master
- Dart version : 2.17.x or later.
- Publish : Yes. Refer to packages with
angel3_
prefix on pub.dev. - Null Safety : Yes
- Status : Production
- Notes : Use this branch for all PR submission
For more details, checkout Project Status
Next Release 8.0.0
- Branch:
feature/v8
- Update all
angel3_
packages to require dart >= 3.0.x - Resolve issues related to generated container
- Improve HTTP and ORM performance
- Improve ORM for MySQL
- Add cache support in ORM (using Redis)
Release Notes
Release 7.0.0 (Current Release)
- Updated all
angel3_
packages to require dart >= 2.17.x - Updated dependencies to the latest libraries
- Updated code generator to use
analyzer
5.x.x - Fix ORM issues
Release 6.0.0 (Previous Release)
- Update all
angel3_
packages to 6.0.0 - Update all
angel3_
packages to require dart >= 2.16.x - Update ORM to support MariaDB 10.2.x (stable) and MySQL 8.x (beta)
- Update code generator to use
analyzer
3.x.x - Update exception handling
- Added default logger to generate standardised logging messages
- Added
melos
support - Removed deprecated API
- [Breaking]
error
forAngelHttpException
is no longer mandatory
Installation and Setup
Create a new project by cloning from boilerplate templates
-
Download and install Dart
-
Clone one of the following starter projects:
-
Run the project in development mode (hot-reloaded is enabled on file changes).
dart --observe bin/dev.dart
-
Run the project in production mode (hot-reloaded is disabled).
dart bin/prod.dart
-
Run as docker. Edit and build the image with the provided
Dockerfile
file. -
Next, refer to the developer guide to learn more about Angel3 framework.
Create a new project with Angel3 CLI
-
Download and install Dart
-
Install the Angel3 CLI:
dart pub global activate angel3_cli
-
On terminal, create a new project:
angel3 init hello
-
Run the project in development mode (hot-reloaded is enabled on file changes).
dart --observe bin/dev.dart
-
Run the project in production mode (hot-reloaded is disabled).
dart bin/prod.dart
-
Run as docker. Edit and build the image with the provided
Dockerfile
file. -
Next, refer to the developer guide to learn more about Angel3 framework.
Migrating from Angel to Angel3
Check out Migrating to Angel3
Performance Benchmark
The performance benchmark can be found at
TechEmpower Framework Benchmarks Round 21
The test cases are build using standard Angel3 ORM
template. The result are used for fine-tuning Angel3 framework. The following test cases will be added in the upcoming update to the benchmark.
- Cache
- Angel3 with MongoDB
Examples and Documentation
Visit the User Guide for dozens of guides and resources, including video tutorials, to get up and running as quickly as possible with Angel3 framework.
Examples and complete projects can be found here.
You can also view the Angel3 API.
Contributing
Interested in contributing to Angel3? See the contribution guide here.
Donation & Support
If you like this project and interested in supporting its development, you can make a donation via paypal service.