mrpastewart/platform
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 2016-12-13 11:16:19 -05:00 committed by GitHub
parent 391924ea0b
commit acbe7d3738
1 changed files with 0 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -4,55 +4,3 @@ An easily-extensible web server framework in Dart.
[Wiki](https://github.com/angel-dart/angel/wiki)
[API Documentation](http://www.dartdocs.org/documentation/angel_framework/latest)
# 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.
Thus, the third, and perhaps most important goal of the Angel framework is to be isomorphic. Angel is designed from the ground up to share code across the server and client. The client libraries even expose an identical API to the server implementation. Creating a full-stack app should be a streamlined experience, and this is virtually impossible without shared code.
Angel also prioritizes tooling. The app boilerplate is pre-fitted with all the plugins and configuration you need to launch an MVP in a matter of days. There is also Swagger code generator in the works. The rest is just implementation detail for you. No need to worry about the following:
* [Authentication](https://github.com/angel-dart/auth)
* [Configuration](https://github.com/angel-dart/configuration)
* [CORS](https://github.com/angel-dart/cors)
* [Diagnostics & Logging](https://github.com/angel-dart/diagnostics)
* [MongoDB](https://github.com/angel-dart/mongo)
* [Mustache](https://github.com/angel-dart/mustache)
* [Reverse Proxy](https://github.com/angel-dart/proxy)
* [Standalone Router](https://github.com/angel-dart/route)
* [Static Files](https://github.com/angel-dart/static)
It's all taken care of for you.
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:
[@_wapaa_](http://twitter.com/_wapaa_)
Or, check out [my blog](http://blog.thosakwe.com).