├── LICENSE.txt └── README.md /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2016 by Gadi Cohen & Tim Mikeladze 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gongo 2 | 3 | Reactive, realtime, offline queries with a 👌 developer experience. 4 | 5 | **In active development, please give feedback GitHub issues** 6 | 7 | Copyright (c) 2020 by Gadi Cohen. Released under the [MIT license](./LICENSE.txt). 8 | 9 | ## Features / TODO 10 | 11 | * Client-side mongo-like database makes CRUD operations a joy 12 | * Works with any server-side database (currently MongoDB supported, FaunDB planned) 13 | * Queries are reactive and realtime* (live), with optimistic updates for free 14 | * Works offline, syncs on reconnect, persists with IndexedDB 15 | * Great experience to use with React, etc. 16 | * Highly scalable serverless implementation 17 | 18 | Note*: Client-side queries are realtime, but depend on your subscription 19 | transports. Due to feedback, we have refocused attention to serverless 20 | polling ("near-realtime") vs the original websocket server (true realtime). 21 | 22 | For the v1 code, see [https://github.com/gongojs/old-v1](gongojs/old-v1). 23 | 24 | ## Project Status 25 | 26 | This is the main project page. Please open issues here for general comments, 27 | vision, features. For anything more specific, please try open an issue on 28 | the specific component's page (client, react, server, mongodb, etc). 29 | 30 | | Package | Version | Build | Coverage 31 | | ----------------- | ------- | ----- | -------- 32 | | [gongo-client](https://github.com/gongojs/gongo-client) | ![npm](https://img.shields.io/npm/v/gongo-client) | [![CircleCI](https://img.shields.io/circleci/build/github/gongojs/gongo-client)](https://circleci.com/gh/gongojs/gongo-client) |[![coverage](https://img.shields.io/codecov/c/github/gongojs/gongo-client)](https://codecov.io/gh/gongojs/gongo-client) 33 | | [gongo-client-react](https://github.com/gongojs/gongo-client-react) | ![npm](https://img.shields.io/npm/v/gongo-client-react) | [![CircleCI](https://img.shields.io/circleci/build/github/gongojs/gongo-client-react)](https://circleci.com/gh/gongojs/gongo-client-react) |[![coverage](https://img.shields.io/codecov/c/github/gongojs/gongo-client-react)](https://codecov.io/gh/gongojs/gongo-client-react) 34 | | [gongo-server](https://github.com/gongojs/gongo-server) | ![npm](https://img.shields.io/npm/v/gongo-server) | [![CircleCI](https://img.shields.io/circleci/build/github/gongojs/gongo-server)](https://circleci.com/gh/gongojs/gongo-server) | [![coverage](https://img.shields.io/codecov/c/github/gongojs/gongo-server)](https://codecov.io/gh/gongojs/gongo-server) 35 | | [gongo-server-db-mongo](https://github.com/gongojs/gongo-server-db-mongo) | ![npm](https://img.shields.io/npm/v/gongo-server-db-mongo) | [![CircleCI](https://img.shields.io/circleci/build/github/gongojs/gongo-server-db-mongo)](https://circleci.com/gh/gongojs/gongo-server-db-mongo) |[![coverage](https://img.shields.io/codecov/c/github/gongojs/gongo-server-db-mongo)](https://codecov.io/gh/gongojs/gongo-server-db-mongo) 36 | | [example](https://github.com/gongojs/example) | n/a | [![CircleCI](https://img.shields.io/circleci/build/github/gongojs/example)](https://circleci.com/gh/gongojs/example) |[![coverage](https://img.shields.io/codecov/c/github/gongojs/example)](https://codecov.io/gh/gongojs/example) 37 | 38 | ## Quick Start 39 | 40 | Currently I use this internally for a few projects. If you're impatient and 41 | want to take it for a spin, open an issue :) 42 | 43 | ### How it differs from Meteor 44 | 45 | To be clear, the concept and data flow is very similar to Meteor. I spent 46 | years working with Meteor and have a lot of love for the team and community. 47 | 48 | If, for whatever reason, you choose not to use Meteor for a particular project, 49 | this package aims to return the joyful developer experience to creating apps 50 | while addressing some of the shortcomings. 51 | 52 | More in [meteor.md](./docs/meteor.md). 53 | 54 | ## Credits 55 | 56 | * Biggest credit is to the incredible METEOR TEAM who completely revolutionized 57 | the developer experience for modern web apps. The inspiration for this project 58 | is to imitate the Meteor Development Experience outside of Meteor. 59 | 60 | ## Development / Get involved 61 | 62 | See [CONTRIBUTING.md](./CONTRIBUTING.md). 63 | 64 | ## Q&A 65 | 66 | 1. **GraphQL does case X better.** 67 | Use GraphQL for case X. 68 | --------------------------------------------------------------------------------