github-search-engine

Very simple and reusable React.js debounced autocomplete component which searches through GitHub v3 REST API for repositories or usernames matching provided string. Styled with material-ui, state structure managed by redux.

Usage no npm install needed!

<script type="module">
  import githubSearchEngine from 'https://cdn.skypack.dev/github-search-engine';
</script>

README

Github Search Engine

Very simple and reusable React.js debounced autocomplete component which searches through GitHub v3 REST API for repositories or usernames matching provided string. Styled with material-ui, state structure managed by redux.

live demo

Installation

npm:

$ npm install --save github-search-engine

yarn:

$ yarn add --save github-search-engine

disclaimer: For now it is required to also install node-fetch in order to completely use this component. Github's api client operates on it and I didn't find time for now to try and appropriately handle it during bundling.

Usage

import React from 'react';
import GithubSearchEngine from 'github-search-engine';
    
const App = () => {
    return (
        <div>
            // ...
            <GithubSearchEngine />
        </div>
    );
};

export default App;

For now the component doesn't take in any props, including potential keys for github api. Might be a matter to change in the future.