grapher/README.md

62 lines
1.7 KiB
Markdown
Raw 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-09-23 13:41:13 +03:00
What ?
------
2016-09-23 14:11:05 +03:00
*Grapher* is a high performance data grapher:
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-09-23 13:41:13 +03:00
How does this compare to [ApolloStack](http://www.apollostack.com/) ?
- You can plug it in your Meteor app directly. It will just work.
- It is built for performance and high data load.
- Apollo tries to satisfy everybody, we are limited to Meteor only.
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-16 19:22:12 +03:00
2016-09-14 16:04:08 +03:00
Documentation
-------------
Please read the documentation:
2016-09-15 09:14:15 +03:00
- How to link collections ? [Collection Links](docs/links.md)
- How to securely expose data ? [Exposing Collections](docs/exposure.md)
- How to search for the data ? [Query](docs/query.md)
API
---
[Quick Reference API](docs/api.md)
2016-09-19 12:47:43 +03:00
Useful packages and integrations
--------------------------------
#### Integration with React (cultofcoders:grapher-react)
- [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)
- [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