algolia / instantsearch-templates

[DEPRECATED] Sample templates for InstantSearch projects

⚠️ DEPRECATED

This repository has been replaced by Create InstantSearch App. This is a command-line tool to bootstrap InstantSearch applications and that creates templates usable on CodeSandbox.

Find all templates in the templates branch.

InstantSearch templates

Table of Contents generated with DocToc

• What is this?
• Goal
• CodeSandbox links
• Running examples locally

What is this?

This repository holds a set of starter templates for all the projects of the InstantSearch team at Algolia.

All the templates are displaying the same search UI:

The JavaScript client and helper templates are not full search UIs because we do not recommend you to use them for that. But we still provide quick templates for those so that you can demonstrate bugs when needed.

Goal

The goal is to use those templates in any situation where:

• as a user, you want to showcase us some code example
• as a user, you want to showcase us a bug in our libraries
• as a contributor, you want to ask a user to show us a bug
• you just want to kickstart a demo
• those templates are also linked inside our GitHub issue templates

This repository is automatically linked to CodeSandbox, so all examples are available inside a nice online code editor with live preview.

If the repository is updated, the online examples will be updated too, very handy!

CodeSandbox links

Here are the CodeSandbox links for all projects:

• InstantSearch.js
• React InstantSearch
• Angular InstantSearch
• Vue InstantSearch
• Autocomplete.js
• JavaScript client
• JavaScript helper

Running examples locally

Requirements:

• Node.js >= v9.6.1, use nvm - install instructions
• Yarn >= v1.3.2 - install instructions

cd ~/Dev
git clone [email protected]:algolia/instantsearch-templates.git
cd instantsearch-templates
yarn
yarn isjs # InstantSearch.js
yarn ris # React InstantSearch
yarn ais # Angular InstantSearch
yarn vis # Vue InstantSearch
yarn ajs # Autocomplete.js
yarn jsclient # JavaScript client
yarn jshelper # JavaScript helper

instantsearch-templates's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

File: src/JavaScript client/package.json
Error type: package.json configuration error
Message: Nested package.json must not contain renovate configuration

Setup ESLint & Prettier?

Add Angular InstantSearch template

Local support should work well.

As for CodeSandbox support, it seems to be only feasible when codesandbox/codesandbox-client#335 is dealt with

Where is renovate?

I think I configured renovate but it's nowhere here :D Maybe because everything is already pinned and it will only be active if new updates + on weekend, let's wait a bit

Deprecate in favor of Create InstantSearch App

As Create InstantSearch App now supports all the templates that this repository provides (see algolia/create-instantsearch-app#76), should we archive this repo?

Check the templates branch of Create InstantSearch App.

Let me know if there's anything that is missing in Create InstantSearch App.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

File: src/InstantSearch.js/package.json
Error type: Nested package.json must not contain renovate configuration. Please use packageRules with paths in your main config instead.

Add Vue template

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop renovations until it is fixed.

Configuration file: React InstantSearch/package.json
Error type: Cannot parse package.json
Message: This package.json contains invalid JSON and cannot be parsed. Please fix it, or add it to your "ignorePaths" array in your renovate config so that Renovate can continue.