Ready for docs
This commit is contained in:
parent
53eadf92eb
commit
1442a6d0b6
3 changed files with 48 additions and 8 deletions
40
README.md
Normal file
40
README.md
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
# Angel
|
||||||
|
An easily-extensible web server framework in Dart.
|
||||||
|
|
||||||
|
[Documentation](https://github.com/angel-dart/angel/wiki)
|
||||||
|
|
||||||
|
# About
|
||||||
|
|
||||||
|
I come from Node development, usually with Express and FeathersJS. When I started learning
|
||||||
|
Dart, I fell in love with it and the huge potential it has on the client-side. But I did
|
||||||
|
feel that server-side was lacking.
|
||||||
|
|
||||||
|
The goal of Angel is to present a server environment navigable to JavaScript pilgrims,
|
||||||
|
but also powerful enough to build robust JSON API's in little time. Another focus is to
|
||||||
|
make Angel extremely extensible, and thus most of the most common business logic is
|
||||||
|
shipped as its own separate Angel plugin.
|
||||||
|
|
||||||
|
In my opinion, it makes no sense that today's frontend tools have no real sense of
|
||||||
|
integration with backend tools, at least in JavaScript, where there are a trillion
|
||||||
|
of each. With the right server framework in Dart, we can build full-stack apps that
|
||||||
|
breathe and function as one single body, rather than as two segregated, monolithic units.
|
||||||
|
|
||||||
|
Tally ho!
|
||||||
|
|
||||||
|
# Development
|
||||||
|
The base of Angel is just about done, but it still needs more
|
||||||
|
unit tests before it is ready for production.
|
||||||
|
|
||||||
|
If you'd like to contribute, feel free to read the docs (as well
|
||||||
|
as though generated by dartdoc), and then clone the repo. I plan to eventually
|
||||||
|
integrate Angel with Travis, so we can merge pull requests faster.
|
||||||
|
|
||||||
|
# Thanks for using Angel
|
||||||
|
|
||||||
|
Thank you for using this library. I hope you like it. I have put months of effort
|
||||||
|
into Angel.
|
||||||
|
|
||||||
|
Feel free to follow me on Twitter:
|
||||||
|
[@thosakwe](http://twitter.com/thosakwe)
|
||||||
|
|
||||||
|
Or, check out [my blog](http://blog.thosakwe.com)
|
|
@ -8,7 +8,7 @@ import 'package:angel_mustache/angel_mustache.dart';
|
||||||
import 'routes.dart';
|
import 'routes.dart';
|
||||||
|
|
||||||
configureServer(Angel app) async {
|
configureServer(Angel app) async {
|
||||||
app.configure(loadConfigurationFile());
|
await app.configure(loadConfigurationFile());
|
||||||
await app.configure(mustache(new Directory('views')));
|
await app.configure(mustache(new Directory('views')));
|
||||||
await app.configure(configureRoutes);
|
await app.configure(configureRoutes);
|
||||||
}
|
}
|
14
pubspec.yaml
14
pubspec.yaml
|
@ -4,11 +4,11 @@ version: 0.0.0-dev.0
|
||||||
author: thosakwe <thosakwe@gmail.com>
|
author: thosakwe <thosakwe@gmail.com>
|
||||||
homepage: https://github.com/angel-dart/angel
|
homepage: https://github.com/angel-dart/angel
|
||||||
dependencies:
|
dependencies:
|
||||||
angel_configuration: ">= 1.0.0-dev < 2.0.0"
|
angel_configuration: ">=1.0.0-dev <2.0.0"
|
||||||
angel_framework: ">=0.0.0-dev < 0.1.0"
|
angel_framework: ">=1.0.0-dev <2.0.0"
|
||||||
angel_mustache: ">= 1.0.0-dev < 2.0.0"
|
angel_mustache: ">=1.0.0-dev <2.0.0"
|
||||||
angel_static: ">= 1.0.0-beta.1 < 1.1.0"
|
angel_static: ">=1.0.0 <1.1.0"
|
||||||
json_god: ">= 1.0.0 < 2.0.0"
|
json_god: ">=2.0.0-beta <3.0.0"
|
||||||
dev_dependencies:
|
dev_dependencies:
|
||||||
http: ">= 0.11.3 < 0.12.0"
|
http: ">=0.11.3 <0.12.0"
|
||||||
test: ">= 0.12.13 < 0.13.0"
|
test: ">=0.12.13 <0.13.0"
|
Loading…
Reference in a new issue