grapher/README.md

106 lines
2.7 KiB
Markdown
Raw Normal View History

2017-11-30 22:11:43 +02:00
# Grapher 1.3
2016-09-14 16:04:08 +03:00
2016-09-24 08:20:00 +03:00
[![Build Status](https://api.travis-ci.org/cult-of-coders/grapher.svg?branch=master)](https://travis-ci.org/cult-of-coders/grapher)
2016-09-14 16:04:08 +03:00
2018-03-29 19:04:43 +03:00
_Grapher_ is a Data Fetching Layer on top of Meteor and MongoDB. It is production ready and battle tested.
2016-10-05 11:52:48 +03:00
2017-11-30 22:11:43 +02:00
Main features:
2018-03-29 19:04:43 +03:00
* Innovative way to make MongoDB relational
* Blends in with Apollo GraphQL making it highly performant
* Reactive data graphs for high availability
* Incredible performance
* Denormalization ability
* Connection to external data sources
* Usable from anywhere
2016-10-05 11:52:48 +03:00
2017-11-30 22:11:43 +02:00
It marks a stepping stone into evolution of data, enabling developers to write complex and secure code,
while maintaining the code base easy to understand.
2018-02-27 17:22:58 +02:00
Grapher 1.3 is LTS until 2024
2018-03-29 19:04:43 +03:00
[Read more about the GraphQL Bridge](docs/graphql.md)
2017-11-30 22:19:23 +02:00
### Installation
2018-03-29 19:04:43 +03:00
2017-11-30 22:11:43 +02:00
```
meteor add cultofcoders:grapher
2016-10-14 11:00:03 +03:00
```
2017-11-30 22:11:43 +02:00
2017-12-01 12:34:06 +02:00
### [Documentation](docs/index.md)
2017-12-21 19:59:15 +02:00
This provides a learning curve for Grapher and it explains all the features. If you want to visualize the documentation better, check it out here:
https://cult-of-coders.github.io/grapher/
2017-11-30 22:19:23 +02:00
2017-12-01 12:34:06 +02:00
### [API](docs/api.md)
Grapher cheatsheet, after you've learned it's powers this is the document will be very useful.
2017-11-30 22:19:23 +02:00
2017-12-21 21:23:05 +02:00
### Useful packages
2017-11-30 22:11:43 +02:00
2018-03-29 19:04:43 +03:00
* Live View: https://github.com/cult-of-coders/grapher-live
* Graphical Grapher: https://github.com/Herteby/graphical-grapher
* React HoC: https://github.com/cult-of-coders/grapher-react
* VueJS: https://github.com/Herteby/grapher-vue
2017-11-30 22:11:43 +02:00
### Events for Meteor (+ Grapher, Redis Oplog and GraphQL/Apollo)
* Meteor Night 2018: [Arguments for Meteor](https://drive.google.com/file/d/1Tx9vO-XezO3DI2uAYalXPvhJ-Avqc4-q/view) - Theodor Diaconu, CEO of Cult of Coders: “Redis Oplog, Grapher, and Apollo Live.
2017-11-30 22:19:23 +02:00
### Premium Support
2017-11-30 22:11:43 +02:00
2018-03-29 19:04:43 +03:00
If you are looking to integrate Grapher in your apps and want online or on-site consulting and training,
2017-11-30 22:19:23 +02:00
shoot us an e-mail contact@cultofcoders.com, we will be more than happy to aid you.
### Quick Illustration
Query:
2018-03-29 19:04:43 +03:00
2017-11-30 22:19:23 +02:00
```js
2017-11-30 22:11:43 +02:00
createQuery({
posts: {
title: 1,
author: {
2018-03-29 19:04:43 +03:00
fullName: 1,
2017-11-30 22:11:43 +02:00
},
comments: {
text: 1,
createdAt: 1,
author: {
2018-03-29 19:04:43 +03:00
fullName: 1,
},
2017-11-30 22:11:43 +02:00
},
categories: {
2018-03-29 19:04:43 +03:00
name: 1,
},
},
2017-11-30 22:11:43 +02:00
}).fetch();
2017-11-30 22:19:23 +02:00
```
Result:
2018-03-29 19:04:43 +03:00
2017-11-30 22:19:23 +02:00
```
2017-11-30 22:11:43 +02:00
[
{
_id: 'postId',
title: 'Introducing Grapher',
author: {
_id: 'authorId',
fullName: 'John Smith
},
comments: [
{
_id: 'commentId',
text: 'Nice article!,
createdAt: Date,
2016-10-14 11:00:03 +03:00
author: {
2017-11-30 22:11:43 +02:00
fullName: 1
2016-10-14 11:00:03 +03:00
}
}
2017-11-30 22:11:43 +02:00
],
categories: [ {_id: 'categoryId', name: 'JavaScript'} ]
2016-10-14 11:00:03 +03:00
}
2017-11-30 22:11:43 +02:00
]
2017-11-30 22:19:23 +02:00
```