Coder Social home page Coder Social logo

bradparks / research-engine Goto Github PK

View Code? Open in Web Editor NEW

This project forked from worldbrain/legacy-research-engine

0.0 1.0 0.0 14.73 MB

WorldBrain's Chrome Extension to full-text search through your browser history & bookmarks.

Home Page: http://www.worldbrain.io

License: GNU General Public License v3.0

HTML 6.14% CSS 6.91% JavaScript 86.95%

research-engine's Introduction

WorldBrain (Re)Search Engine

Welcome to the WorldBrain project. We want to work on the goal of an increased (scientific) literacy in our global society through a better information quality on the internet.

WorldBrain is an open-source project that aims to battle (scientific) misinformation by developing open source search tools for professional web-researchers like science communicators, STEM students, journalists and librarians and online debaters to find, rate and share qualitative and trustworthy web content/notes with their friends, followers and the public. (Watch the 3.5 min Vision Video)

Our first software, The (Re)search engine, is an open-source search engine for a user’s digital knowledge. It lets them full-text search all the pages they visited and bookmarked, as well as other places like Evernote, Pocket, Google Drive, Asana, Mendeley etc. (Watch 2 min Intro Video)

Table of Content

  1. Status & Development Roadmap
  2. How to get involved
  3. How to use the extension
  4. FAQs
  5. Installation (as user & developer)
  6. How to get in touch with us
  7. Acknowledgements
  8. Licence

Status & Development Roadmap

Here you find the long term roadmap.

Current Stage

In it's current stage, the chrome extension lets you full-text search all the web pages and PDFs you visited and bookmarked.

Features

  • full-text search history & bookmarks
  • import existing history and bookmarks
  • blacklisting urls, domains
  • supports PDFs you visited online

Under Development

We are currently working on replacing the DB with PouchDB and the default search implementation with PouchDB Quick Search

View all "UNDER DEVELOPMENT" issues

Up next

Web-view for results and more filter options.

Currently the results can only be shown in the drop down of the adress bar and filters only applied by entering queries.

To change that, we are adding a web-based results and filter view (much like a google results page), where all results can be shown and a variety of filters applied.

More info in our projects section

How to get involved

How to use the extension

You can watch our "How to use the Research-Engine" Demo Video (2min)

or for a more detailed description, visit the text-based tutorial.

FAQ

You can reach our FAQ here: reddit.com*/r/*WorldBrain

Installation

AS A USER

Install from the Chrome store here. (If you don't feel comfortable with that, look at Transparent Installation).

Transparent Installation

If you don't feel comfortable installing a Chrome extension that can read and modify all data on the websites you visit from the webstore (we wouldn't either!), you can clone this repository on your local machine, read through our code to verify that it is not malicious, and then install it as an unpacked local extension through the menu in chrome://extensions/. But this way you also won't receive any updates.

AS A DEVELOPER

Fork the project, then...

Prerequisites

  • Install browserify and watchify with npm install -g browserify
  • Run npm install to install dependencies

While Developing

  • npm run watch

Build

  • npm run build

Activate & Test the plugin on your browser

In Chrome
  • go to chrome://extensions/
  • Activate Developer Mode (top right)
  • Click load unpacked extension (top left)
  • Select the /build folder from the project

How to get in touch with us

  1. via Email: [email protected]
  2. Request Slack Invitation: http://worldbrain.slack.com

Acknowledgements

This tool is originally released under the name "Falcon" and will be further developed to fit the needs of the scientific research community. The original programmers are @andrewilyas and @lengstrom.

License

Currently the (Re)search-Engine is released under GPL-3, as this has been the license of Falcon. We aim to release it under a more liberal license as soon as we have replaced all the code from the original Falcon tool.

Our goal is to provide a set of reusable libraries, so that this client can be adapted to as many work-flows as possible.

research-engine's People

Contributors

andrewilyas avatar blackforestboi avatar colejohnson66 avatar fuzzmz avatar jsonmorris avatar lengstrom avatar michaelmior avatar mirko911 avatar niieani avatar obsidianart avatar tobeorla avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.