From d970bef195c82419ce00faeaa28e18601238a32a Mon Sep 17 00:00:00 2001 From: Tobe O Date: Sat, 15 Feb 2020 18:35:27 -0500 Subject: [PATCH] new readme --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..151d490f --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +[![The Angel Framework](https://angel-dart.github.io/assets/images/logo.png)](https://angel-dart.dev) + +[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/angel_dart/discussion) +[![Pub](https://img.shields.io/pub/v/angel_framework.svg)](https://pub.dartlang.org/packages/angel_framework) +[![Build status](https://travis-ci.org/angel-dart/framework.svg?branch=master)](https://travis-ci.org/angel-dart/framework) +![License](https://img.shields.io/github/license/angel-dart/framework.svg) + +**A polished, production-ready backend framework in Dart.** + +*Note: This repo is an application boilerplate ,and not the underlying framework library.* + +----- +## 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](https://github.com/angel-dart/graphql) +* [PostgreSQL ORM](https://github.com/angel-dart/orm) +* [Dependency Injection](https://docs.angel-dart.dev/guides/dependency-injection) +* And [much more](https://github.com/angel-dart)... + +## Installation & Setup + +Once you have [Dart](https://www.dartlang.org/) installed, bootstrapping a project is as simple as running a few shell commands: + +Install the [Angel CLI](https://github.com/angel-dart/cli): + +```bash +pub global activate angel_cli +``` + +Bootstrap a project: + +```bash +angel init hello +``` + +You can even have your server run and be *hot-reloaded* on file changes: + +```bash +dart --observe bin/dev.dart +``` + +Next, check out the [detailed documentation](https://docs.angel-dart.dev/v/2.x) to learn to flesh out your project. + +## Examples and Documentation +Visit the [documentation](https://docs.angel-dart.dev/v/2.x) +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](https://github.com/angel-dart/examples-v2). + + +You can also view the [API Documentation](http://www.dartdocs.org/documentation/angel_framework/latest). + +There is also an [Awesome Angel :fire:](https://github.com/angel-dart/awesome-angel) list. +