Meteor-Community-Packages / Meteor-Community-Packages/ground-db

Ground.Collection 1.0.0

Open
#118 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
569
Forks
77
PR merge metrics
No merged PRs in 30d

Description

Tracking WIP releases, first release is a complete rewrite in ES2015 using `localforage` as the storage adapter.

Requires `METEOR@1.2-rc.4`
#### Notes
- `Ground.Collection(name, options)` extends `Mongo.Collection` with a few extra options
- Support for `localstorage`/`indexedDB`/`webSQL`/`SQLlite` _(on cordova)_
- Pr. document updates (old uses bulk)
- Added async loading - this should improve performance even on large datasets
#### TODO
- [ ] Conflict handling (method resume/removal/updates of documents)
- [ ] Add document compression?
- [ ] Only subscribe to actual updates - prevent refetching
- [ ] Handle storage errors - eg. when hitting limits
- [ ] Storage quota handling?
- [ ] Add test coverage
- [ ] Add tab sync - maybe as a seperate package?
- [ ] Add support for blobs?
- [ ] Add support for indexes?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Ground.Collection(name, options) rewrite described in the issue and its localforage storage-adapter requirements. The issue provides no file or test path and lists several unresolved design areas, so a contributor would first need to choose and scope one TODO; completion would require an agreed implementation and added test coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.