mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
The Protevus Platform: Unified Full-Stack Development https://protevus.com
2761 commits 4 branches 0 tags 49 MiB
Dart 99.6%
HTML 0.3%
Find a file
thomashii 7ff5021491 Updated README.md
2021-03-13 10:32:48 +08:00
.github Create FUNDING.yml 2019-05-29 03:06:49 -04:00
.vscode Updated dart requirements to 2.10 2021-02-14 13:22:25 +08:00
packages Updated angel_auth_twitter 2021-03-13 09:33:09 +08:00
tool add move_repos script 2020-02-16 14:28:17 -05:00
.gitignore Upgraded package cli 2021-03-06 19:56:49 +08:00
CHANGELOG.md Updated angel_auth_twitter 2021-03-13 09:33:09 +08:00
LICENSE :) 2016-04-21 22:56:21 -04:00
README.md Updated README.md 2021-03-13 10:32:48 +08:00
requirements.txt add move_repos script 2020-02-16 14:28:17 -05:00
TODO.md Updated dart requirements to 2.10 2021-02-14 13:22:25 +08:00

README.md

The Angel Framework

Gitter Pub Build status License

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 installed, bootstrapping a project is as simple as running a few shell commands:

Install the Angel CLI:

pub global activate angel_cli

Bootstrap a project:

angel init hello

You can even have your server run and be hot-reloaded on file changes:

dart --observe bin/dev.dart

Next, check out the detailed documentation 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 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.

You can also view the API Documentation.

There is also an Awesome Angel 🔥 list.

Contributing

Interested in contributing to Angel? Start by reading the contribution guide here.