Skip to content
This repository has been archived by the owner on May 22, 2021. It is now read-only.

An example of using React with D3, Lunr.js, service workers, and Electron

License

Notifications You must be signed in to change notification settings

thibaudcolas/react-d3-electron

Repository files navigation

📉📈 An example of using React with D3, Lunr.js and an autocomplete UI to build an accessible keyboard-centric search experience. Also – service workers for offline caching, and desktop app with Electron. Demo

Screenshot

Head over to the Releases to download the desktop version.

Installation

You first need to clone the project on your computer, and to install Node. This project also uses nvm.

From the command-line:

cd ~/Development/sites/
git clone git@github.com:thibaudcolas/react-d3-electron.git
cd react-d3-electron

To install our dependencies:

nvm install
# Then, install all project dependencies.
yarn install
# Install the git hooks.
./.githooks/deploy

Working on the project

Everything mentioned in the installation process should already be done.

# Start the server and the development tools.
yarn run start
# Runs tests.
yarn run test

Documentation

This project relies on a modified version of react-autosuggest so that the suggestions are always displayed.