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

Update README.md

Browse source
This commit is contained in:
Tobe O 2017-04-02 16:59:58 -04:00 committed by GitHub
parent 855075db31
commit d1677a335a
1 changed files with 54 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
README.md
View file

@ -3,8 +3,6 @@
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/angel_dart/discussion)
[![version: v1.0.0-beta](https://img.shields.io/badge/pub-v1.0.0--beta-blue.svg)](https://pub.dartlang.org/packages/angel_common)
**The Dart server framework that's ready for showtime.**
[Wiki (in-depth documentation)](https://github.com/angel-dart/angel/wiki)
[API Documentation](http://www.dartdocs.org/documentation/angel_common/latest)
@ -13,12 +11,9 @@
[File an Issue](https://github.com/angel-dart/roadmap/issues)
**The Dart server framework that's ready for showtime.**
With features like the following, Angel is the all-in-one framework you should choose to build your next project:
* [Advanced, Modular Routing](https://github.com/angel-dart/route)
* [Middleware](https://github.com/angel-dart/angel/wiki/Middleware)
* [Dependency Injection](https://github.com/angel-dart/angel/wiki/Dependency-Injection)
* And [much more](https://github.com/angel-dart)...
Angel is a full-featured server-side Web application framework for the Dart programming language. It strives to be a flexible, extensible system, to be easily scalable, and to allow as much code to be shared between clients and servers as possible. Ultimately, I believe that this approach will shorten the time it takes to build a full-stack Web application, from start to finish. [Read more...](https://medium.com/the-angel-framework/announcing-angel-v1-0-0-beta-46dfb4aa8afe)
## Installation & Setup
*Having errors with a fresh Angel installation? See [here](https://github.com/angel-dart/angel/wiki/Installation-&-Setup) for help.*
@ -45,10 +40,59 @@ angel start
Next, check out the [detailed documentation](https://github.com/angel-dart/angel/wiki) to learn to flesh out your project.
## What is Angel?
Angel is a server-side Web application framework for the Dart programming language. It strives to be a flexible, extensible system, to be easily scalable, and to allow as much code to be shared between clients and servers as possible. Ultimately, I believe that this approach will shorten the time it takes to build a full-stack Web application, from start to finish.
## Features
With features like the following, Angel is the all-in-one framework you should choose to build your next project:
* [Advanced, Modular Routing](https://github.com/angel-dart/route)
* [Middleware](https://github.com/angel-dart/angel/wiki/Middleware)
* [Dependency Injection](https://github.com/angel-dart/angel/wiki/Dependency-Injection)
* And [much more](https://github.com/angel-dart)...
[Read more...](https://medium.com/the-angel-framework/announcing-angel-v1-0-0-beta-46dfb4aa8afe)
## Basic Example
More examples and complete projects can be found in the [angel-example](https://github.com/angel-example) organization.
The following is an [explosive application](https://github.com/angel-example/explode) complete with a REST API and
WebSocket support.
```dart
import 'dart:async;'
import 'package:angel_common/angel_common.dart';
import 'package:angel_websocket/server.dart';
import 'package:mongo_dart/mongo_dart.dart';
main() async {
var app = await createServer();
var server = await app.startServer(InternetAddress.LOOPBACK_IP_V4, 8080);
print('Angel listening at http://${server.address.address}:${server.port}');
}
Future<Angel> createServer() async {
// Configuration
await app.configure(loadConfigurationFile());
Db db = new Db();
await db.open(app.mongodb_url);
app.container.singleton(db); // Add to DI
// Routes
app.get('/foo', (req, res) => res.render('hello'));
app.post('/query', (Db db) async {
// Db is an injected dependency here :)
return await db.collection('foo').find().toList();
});
// Services (which build REST API's and are broadcasted over WS)
app.use('/bombs', new MongoService(db.collection('bombs')));
app.use('/users', new MongoService(db.collection('users')));
app.use('/explosions', new AnonymousService(create: (data, [params]) => data));
// Setup WebSockets, add GZIP, etc.
await app.configure(new AngelWebSocket(debug: true));
app.responseFinalizers.add(gzip());
return app;
}
```
## Join the team
Do you want to collaborate? Join the project at https://projectgroupie.com/projects/212