History

thomashii c099750755 Updated README		2021-08-20 13:55:04 +08:00
..
.vscode	Migrated angel_configuration	2021-04-10 19:23:57 +08:00
example	Updated framework	2021-07-08 10:42:40 +08:00
lib	Updated sync	2021-08-20 12:59:02 +08:00
performance/hello	Updated framework	2021-07-08 10:42:40 +08:00
test	Updated sync	2021-08-20 12:59:02 +08:00
tool	create packages dir	2020-02-15 18:13:38 -05:00
.travis.yml	create packages dir	2020-02-15 18:13:38 -05:00
analysis_options.yaml	Updated vscode settings	2021-07-08 10:44:27 +08:00
AUTHORS.md	Publish angel3_merge_map and angel3_mock_request	2021-05-14 16:06:16 +08:00
CHANGELOG.md	Updated README	2021-08-20 13:55:04 +08:00
dev.key	create packages dir	2020-02-15 18:13:38 -05:00
dev.pem	create packages dir	2020-02-15 18:13:38 -05:00
LICENSE	Updated license	2021-06-14 11:52:58 +08:00
pubspec.yaml	Updated README	2021-08-20 13:55:04 +08:00
README.md	Updated README	2021-08-20 13:55:04 +08:00

README.md

Angel3 Framework

Replacement of Angel Framework with major change to support NNBD.

Angel3 framework is a high-powered HTTP server with support for dependency injection, sophisticated routing, authentication, ORM, graphql etc. It is designed to keep the core minimal but extensible through a series of plugin packages. It won't dictate which features, databases or web templating engine to use. This flexibility enable Angel3 framework to grow with your application as new features can be added to handle the new use cases.

This package is the core of the Angel3 framework. To see more details, please refer to the Developer Guide.

Installation and Setup

(Option 1) 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.

(Option 2) 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.

Migrating from Angel to Angel3

Check out Migrating to Angel3