Skip to content

Commit

Permalink
Updated VueIS geosearch demo README (#371)
Browse files Browse the repository at this point in the history
* Updated VueIS geosearch demo README

* Update Vue InstantSearch/geo-search/README.md

Co-authored-by: Haroen Viaene <hello@haroen.me>

* Update Vue InstantSearch/geo-search/README.md

Co-authored-by: Haroen Viaene <hello@haroen.me>

Co-authored-by: Haroen Viaene <hello@haroen.me>
  • Loading branch information
seafoox and Haroenv authored Mar 17, 2022
1 parent 988640b commit 6531a9b
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 18 deletions.
49 changes: 31 additions & 18 deletions Vue InstantSearch/geo-search/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,39 @@
# vue-instantsearch-v2-starter
# Geo-search example with Vue InstantSearch and Google Maps

## Project setup
```
yarn install
```
This example shows you how to add Geo search capabilities to your Vue InstantSearch implementation and displaying the found results via Google Maps.

### Compiles and hot-reloads for development
```
yarn run serve
```
<p align="center"><img src="capture.jpg" alt="A capture of the Geo-search example with Vue InstantSearch and Google Maps demo" /></p>

### Compiles and minifies for production
```
yarn run build
```
## Demo

### Run your tests
```
yarn run test
[Access the demo](https://codesandbox.io/s/github/algolia/doc-code-samples/tree/master/Vue%20InstantSearch/geo-search)

## How to run this example locally

### 1. Clone this repository

```sh
git clone git@github.com:algolia/doc-code-samples.git
```

### Lints and fixes files
### 2. Install the dependencies and run the server

```sh
cd Vue InstantSearch/geo-search
yarn
yarn serve
```
yarn run lint

Alternatively, you may use npm:

```sh
cd Vue InstantSearch/geo-search
npm
npm serve
```

Open <http://localhost:8080> to see your app.

## Additional resources
Learn more [Geo Search with Vue InstantSearch](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/geo-search/vue/) in the Algolia documentation.

Binary file added Vue InstantSearch/geo-search/capture.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6531a9b

Please sign in to comment.