mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Thomas Hii 2024-07-07 23:40:44 +08:00
parent 5c19a002b6
commit bc5ad58aa5
1 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -4,7 +4,7 @@
![Pub Version (including pre-releases)](https://img.shields.io/pub/v/angel3_framework?include_prereleases) ![Pub Version (including pre-releases)](https://img.shields.io/pub/v/angel3_framework?include_prereleases)
[![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety) [![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) [![Discord](https://img.shields.io/discord/1060322353214660698)](https://discord.gg/3X6bxTUdCM)
[![License](https://img.shields.io/github/license/dart-backend/angel)](https://github.com/dart-backend/angel/LICENSE) [![License](https://img.shields.io/github/license/dart-backend/angel)](https://github.com/dart-backend/angel/LICENSE)
[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos) [![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos)
@ -18,16 +18,15 @@ Angel3 originated from a fork of the archived Angel framework in support of Dart
The available features in Angel3 includes: The available features in Angel3 includes:
* Server-Side Rendering (Markdown, Mustache, Jinja, JAEL)
* OAuth2 Authentication * OAuth2 Authentication
* WebSocket * WebSocket
* HTTP/2 * HTTP/2
* HTTP Streaming * HTTP Streaming
* GraphQL * GraphQL
* ORM for PostgreSQL * Markdown, Mustache, Jinja and JAEL as Server-Side HTML Rendering
* ORM for MySQL * ORM for PostgreSQL and MySQL
* MongoDB * MongoDB, Sembast and RethinkDB as storage
* Cache * Redis as cache
See all of the available [`packages`](https://angel3-docs.dukefirehawk.com/packages) for more information. See all of the available [`packages`](https://angel3-docs.dukefirehawk.com/packages) for more information.
@ -47,7 +46,7 @@ The status of the project is as follows:
Branch: `master` Branch: `master`
* Dart version : 3.0.x or later. * Dart version : 3.x.x or later.
* Publish : Yes. Refer to packages with `angel3_` prefix on [pub.dev](https://pub.dev/publishers/dukefirehawk.com/packages). * Publish : Yes. Refer to packages with `angel3_` prefix on [pub.dev](https://pub.dev/publishers/dukefirehawk.com/packages).
* Null Safety : Yes * Null Safety : Yes
* Status : Production * Status : Production
@ -60,12 +59,13 @@ For more details, checkout [Project Status](https://github.com/dart-backend/ange
### Release 9.0.0 (Future) ### Release 9.0.0 (Future)
* Performance optimsation * Performance optimsation
* Update and enhance ORM to support macro * Update and enhance ORM with macro
### Release 8.0.0 (Current) ### Release 8.0.0 (Current)
* Updated `angel3_` packages to require dart >= 3.0.0 * Updated `angel3_` packages to require dart >= 3.0.0
* Updated dependencies to the latest * Updated dependencies to the latest
* Updated code generator to use `analyzer` 6.x.x
* Resolved issues related to generated container * Resolved issues related to generated container
### Release 7.0.0 ### Release 7.0.0
@ -92,9 +92,8 @@ For more details, checkout [Project Status](https://github.com/dart-backend/ange
* Improve ORM for MySQL * Improve ORM for MySQL
* Add cache support in ORM (using Redis) * Add cache support in ORM (using Redis)
* Upgrade and release angel3_oauth2 8.0.0 (5 failed test cases) * Upgrade and release angel3_oauth2 8.0.0 (5 failed test cases)
* Upgrade and release angel3_auth_twitter 8.0.0 (issue: oauth1 don't support http 1.0.0) * Upgrade and release angel3_auth_twitter 8.0.0 (Migrate to OAuth2)
* Upgrade and release angel3_shelf 8.0.0 (2 failed test cases) * Upgrade and release angel3_shelf 8.0.0 (2 failed test cases)
* Migrate and release angel3_rethink
## Installation and Setup ## Installation and Setup
@ -164,11 +163,11 @@ Check out [Migrating to Angel3](https://angel3-docs.dukefirehawk.com/migration/a
The performance benchmark can be found at The performance benchmark can be found at
[TechEmpower Framework Benchmarks Round 21](https://www.techempower.com/benchmarks/#section=data-r21&test=composite) [TechEmpower Framework Benchmarks](https://www.techempower.com/benchmarks/#section=data-r22&test=composite&hw=ph)
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. 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.
1. Cache 1. Cache with Redis
2. Angel3 with MongoDB 2. Angel3 with MongoDB
## Examples and Documentation ## Examples and Documentation
@ -179,6 +178,10 @@ Examples and complete projects can be found [here](https://github.com/dart-backe
You can also view the [Angel3 API](http://www.dartdocs.org/documentation/angel_framework/latest). You can also view the [Angel3 API](http://www.dartdocs.org/documentation/angel_framework/latest).
## Community
Join us on [Discord](https://discord.gg/3X6bxTUdCM).
## Contributing ## Contributing
Interested in contributing to Angel3? See the contribution guide [here](CONTRIBUTING.md). Interested in contributing to Angel3? See the contribution guide [here](CONTRIBUTING.md).