Main project README

This commit is contained in:
Tobe O 2019-04-18 11:50:49 -04:00
parent bc4448d845
commit c6be9f5773

View file

@ -1,9 +1,14 @@
# graphql ![Logo](https://github.com/angel-dart/graphql/raw/master/img/angel_logo.png)
[![Pub](https://img.shields.io/pub/v/angel_graphql.svg)](https://pub.dartlang.org/packages/angel_graphql)
[![build status](https://travis-ci.org/angel-dart/graphql.svg)](https://travis-ci.org/angel-dart/graphql) <div style="text-align: center">
<hr>
<a href="https://pub.dartlang.org/packages/angel_graphql" rel="nofollow"><img src="https://img.shields.io/pub/v/angel_graphql.svg" alt="Pub" data-canonical-src="https://img.shields.io/pub/v/angel_graphql.svg" style="max-width:100%;"></a>
<a href="https://travis-ci.org/angel-dart/graphql" rel="nofollow"><img src="https://travis-ci.org/angel-dart/graphql.svg" alt="Pub" data-canonical-src="https://img.shields.io/pub/v/angel_graphql.svg" style="max-width:100%;"></a>
</div>
A complete implementation of the official A complete implementation of the official
[GraphQL specification](http://facebook.github.io/graphql/October2016/#sec-Language), [GraphQL specification](https://graphql.github.io/graphql-spec/June2018/),
in the Dart programming language. in the Dart programming language.
The goal of this project is to provide to server-side The goal of this project is to provide to server-side
@ -14,3 +19,17 @@ Included is also
[Angel](https://github.com/angel-dart) framework, allows [Angel](https://github.com/angel-dart) framework, allows
server-side Dart users to build backends with GraphQL and server-side Dart users to build backends with GraphQL and
virtually any database imaginable. virtually any database imaginable.
## Projects
This mono repo is split into several sub-projects,
each with its own detailed documentation and examples:
* `angel_graphql` - Support for handling GraphQL via HTTP and
WebSockets in the [Angel](https://angel-dart.dev) framework. Also serves as the `package:graphql_server` reference implementation.
* `example_star_wars`: An example GraphQL API built using
`package:angel_graphql`.
* `graphql_generator`: Generates `package:graphql_schema` object types from concrete Dart classes.
* `graphql_parser`: A recursive descent parser for the GraphQL language.
* `graphql_schema`: An implementation of GraphQL's type system. This, combined with `package:graphql_parser`,
powers `package:graphql_server`.
* `graphql_server`: Base functionality for implementing GraphQL servers in Dart. Has no dependency on any
framework.