grapher/README.md

76 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2016-09-14 16:04:08 +03:00
Welcome to Grapher
==================
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
2016-10-05 11:52:48 +03:00
Documentation
-------------
[http://grapher.cultofcoders.com](http://grapher.cultofcoders.com/)
Long Term Support
-----------------
2016-10-25 13:03:45 +03:00
Version 1.2 will be supported until 2020.
2016-10-05 11:52:48 +03:00
2016-09-23 13:41:13 +03:00
What ?
------
2016-11-21 15:01:29 +02:00
*Grapher* is a high performance data fetcher and collection relationship manager for Meteor and MongoDB:
2016-09-23 13:41:13 +03:00
1. Makes data MongoDB denormalization easy (storing and linking data in different collections)
2. You can link your MongoDB data with any type of database, and fetch it via Queries
3. You have the same API for data-fetching whether you want your data to be reactive or not.
2016-10-14 11:00:03 +03:00
Sample
-------------
To give you an idea how this works, you can fetch the data like this:
2016-10-14 11:00:03 +03:00
```
{
users: {
2016-10-14 16:22:18 +03:00
profile: 1,
githubTickets: {},
2016-10-14 11:00:03 +03:00
posts: {
2016-10-14 16:22:18 +03:00
title: 1,
2016-10-14 11:00:03 +03:00
comments: {
text: 1,
date: 1,
author: {
profile: 1
}
}
}
}
}
```
2016-09-14 16:04:08 +03:00
2016-09-16 19:22:12 +03:00
Updates
-------
Check-out the [CHANGELOG](CHANGELOG.md) for latest updates.
2016-09-15 11:17:23 +03:00
Installation
------------
```
meteor add cultofcoders:grapher
```
2016-09-19 12:47:43 +03:00
Useful packages and integrations
--------------------------------
#### Integration with React (cultofcoders:grapher-react)
2016-10-05 11:52:48 +03:00
Provides you with an easy to use "createQueryContainer" function.
- [Atmosphere](https://atmospherejs.com/cultofcoders/grapher-react)
- [GitHub](https://github.com/cult-of-coders/grapher-react/)
2016-09-19 12:47:43 +03:00
#### Live View (cultofcoders:grapher-live)
2016-10-05 11:52:48 +03:00
Provides a playground for grapher and provides documentation of your data
- [Atmosphere](https://atmospherejs.com/cultofcoders/grapher-live)
- [GitHub](https://github.com/cult-of-coders/grapher-live)
2016-09-20 12:04:55 +03:00
Boiler plate Meteor + React + Grapher
-------------------------------------
https://github.com/cult-of-coders/grapher-boilerplate