Giter VIP home page Giter VIP logo

github-awesome-autocomplete's Introduction

GitHub Awesome Autocomplete

By working every day on building the best search engine, we've become obsessed with our own search experience on the websites and mobile applications we use. GitHub is quite big for us, we use their search bar every day but it was not optimal for our needs: so we just re-built Github's search the way we thought it should be and we now share it with the community via this Chrome, Firefox and Safari extensions.

Algolia provides a developer-friendly SaaS API for database search. It enables any website or mobile application to easily provide its end-users with an instant and relevant search. With Algolia's unique find as you type experience, users can find what they're looking for in just a few keystrokes. Feel free to give Algolia a try with our 14-days FREE trial at Algolia.

At Algolia, we're git addicts and love using GitHub to store every single idea or project we work on. We use it both for our private and public repositories (12 API clients, DocSearch, HN Search or various d e m o).

Installation

Install it from the stores:

chrome firefox safari

Features

This extension replaces GitHub's search bar and add auto-completion (instant-search & suggestion) capabilities on:

  • top public repositories
  • last active users
  • your private repositories
    • default is without Algolia: done locally in your browser using vanilla JS search
    • ability to use Algolia (typo-tolerant & relevance improved) through a "Connect with GitHub" (oauth2)
  • your issues
    • only available if you choose to "Connect with GitHub"

capture

How does it work?

FAQ

Are my private repositories sent somewhere?

By default your list of private repositories remains in your local storage. You can allow us to crawl your private repositories with a "Connect with GitHub" (oauth2) action. Your private repositories are then stored securely in our index and only you will be able to search them.

My private repository is not searchable, what can I do?

You need to refresh your local list of private repositories:

refresh

Development

Installation

$ git clone https://github.com/algolia/chrome-awesome-autocomplete.git

# in case you don't have Grunt yet
$ sudo npm install -g grunt-cli

Build instructions

$ cd chrome-awesome-autocomplete

# install dependencies
$ npm install

# generate your private key (required for Chrome)
$ openssl genrsa 2048 | openssl pkcs8 -topk8 -nocrypt > mykey.pem

# build it
$ grunt

When developing, write unit-tests, use dev Grunt task to check that your JS code passes linting tests and unit-tests.

When ready to try out the extension in the browser, use default Grunt task to build it. In build directory you'll find develop version of the extension in unpacked-dev subdirectory (with source maps), and production (uglified) version in unpacked-prod directory.

Chrome

The .crx packed version is created from unpacked-prod sources.

Firefox

The xpi archive is created from build/firefox.

Safari

The safariextz archive is created from Safari.

Grunt tasks

  • clean: clean build directory
  • test: JS-lint and mocha test, single run
  • dev: continuous test loop
  • default: clean, test, build step (copy all necessary files to build directory, browserify JS sources, prepare production version (using uglify), pack the crx and xpi

github-awesome-autocomplete's People

Contributors

dprentis avatar jperl avatar lautis avatar marieauxille avatar matthewgertner avatar maur8ino avatar rayrutjes avatar redox avatar seafoox avatar sgtpooki avatar shipow avatar

Watchers

 avatar  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.