holochain / holodex Goto Github PK

View Code? Open in Web Editor NEW

23.0 26.0 4.0 66 KB

Holochain application indexing engine for distributed apps which run on holochains

License: GNU General Public License v3.0

JavaScript 100.00%

holodex's Introduction

holodex

Holochain application indexing engine for distributed apps which run on holochains

Holochain application indexing engine for distributed apps which run on holochains

Code Status: Broken. This app is currently broken and doesn't run. We'll be fixing it soon.

Installation

Prerequiste: Install holochain on your machine. You can install holodex very simply with this:

hcdev init -cloneExample=holodex

Usage

This is a mixin bridged so you don't run it directly and has no UI, instead apps bridge to it.

Tests

To run all the stand alone tests:

hcdev test

Tests currently broken

Feature Roadmap and Current Progress

Contribute

We welcome pull requests and issue tickets. Find us on gitter to chat.

Contributors to this project are expected to follow our development protocols & practices.

License

This program is free software: you can redistribute it and/or modify it under the terms of the license provided in the LICENSE file (GPLv3). This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Note: We are considering other 'looser' licensing options (like MIT license) but at this stage are using GPL while we're getting the matter sorted out.

holodex's People

Contributors

Stargazers

Watchers

Forkers

hc-interns cleancoindev rasikachafekar wladoo

holodex's Issues

Looking at using sphinx for indexing http://sphinxsearch.com/docs/current.html#intro

Creating the holodex app for an index server (basic structure)

writing test cases for anchor zome

Design Decision - anchors used for implementation of keyword indexing - Feedback needed

The latest code commit that I have made to this repository uses anchors to create indexes for the given content against keywords.
Wanted to get some feedback on whether this seems to be a good approach.
Some related documents for reference :
https://docs.google.com/document/d/1ZrS4vyFdaRWpOYjSACugtpmsYhnaNReOX60uQhu3ojU/edit#heading=h.ho9yv71oqdb3
https://docs.google.com/spreadsheets/d/1buiMXxc9n65FBdsORGT1REKsWnMDc8ffjMGJV2N0Lno/edit?ts=5953511e#gid=778768149
https://github.com/Holochain/mixins/wiki/Anchors
@zippy @artbrock @christopherreay @lucksus @jackThammer @tishakitkat

Testing Inter-Zome function call on hashtag

creating tests to check if all input formats are covered in holodex entries

Implementing Our Own "Index as a holochain"

Change the way input is provided for indexing.

This issue addresses how the real time indexing with holodex would work with consumer applications

Have a default language (which will be provided by the HC app using holodex)

Implement smart search (specifying entry type & field values)

Support for a search query to specify entry type and field values to search by. This would involve setting up buntdb to do JSON indexing of the content, and would be a search different from keyword search so that queries can be more targeted.

working on pluggable anchor zome

use test to check indexing function -IndexContent in holodex.

Creating holodex zome under a holochain app(clutter) and figuring out the inputs to the app.

Limit the number of objects that are returned from the search function and add pages

indexing on buntdb side

buntdb JSON indexing will be required to support smart search.

get the volunteering preference without requiring to pass a parameter to bridgeGenesis

holodex funtion calls enabled for non index nodes as well(node to node communication enabled)

Improvising create index function and making sure that the search function is working with it

Test out bridging of holodex with clutter

Project overview

Design : a service that can be used by any of the applications running on holochain which extends the application for applying indexing of content to their applications. The indexing service will provide the functionality of having a configurable number of “volunteer” nodes(that have enough space and processing capacity and public IPs) that would be used as index nodes.
The idea is, to make sure that one node is not overburdened (and control the entire network) with the task of storing all the hashed links from all the nodes in the DHT. Instead, all nodes in a neighborhood will be connected to at least one index node which would be responsible for providing the data from all the other nodes through gossiping with other index nodes.

Implementation : This will be an application, which is built on top of holochain, would let the user application provide the number of index nodes, the entries/types that are to be indexed. Using these specifications holodex would implement algorithms(MapReduce?) to index the chains in a way that would implement the above mentioned design.

In context with the entire holochain project : This is the key feature that would help make holochain applications truly distributed. This also takes care of the limitation that block chain based applications face, that is, of having to store the entire chain of hashes from all the entries of all the nodes in the system.