https://github.com/weaviate-tutorials/vue-vector-search-demo
a demo app showcasing weaviates vector search in vue.js
https://github.com/weaviate-tutorials/vue-vector-search-demo
Last synced: about 1 year ago
JSON representation
a demo app showcasing weaviates vector search in vue.js
- Host: GitHub
- URL: https://github.com/weaviate-tutorials/vue-vector-search-demo
- Owner: weaviate-tutorials
- Created: 2023-09-26T16:30:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-15T11:39:32.000Z (over 2 years ago)
- Last Synced: 2025-01-26T04:26:31.356Z (over 1 year ago)
- Language: Vue
- Size: 409 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Generative Search with [Weaviate](https://weaviate.io/) and [Open AI](https://openai.com/)
This repo should help get you started developing with Weaviate and Vue 3.
## Installation
1. Clone the repo with the following command
```
git clone https://github.com/malgamves/vue-vector-search-demo
```
2. Install the necessary project dependencies with the following command
```
yarn install
```
3. Create a Weaviate instance on Weaviate Cloud Services (WCS) as described in [this guide](https://weaviate.io/developers/weaviate/quickstart#step-2-create-an-instance)
4. Create a `.env` file and add the following keys
- your Open AI API key as `VITE_OPENAI_KEY` (you can get this in your [Open AI settings](https://platform.openai.com/account/api-keys))
- your Weaviate API key as `VITE_WEAVIATE_API_KEY` (you can get this in your [Weaviate dashboard](https://console.weaviate.cloud/dashboard) under sandbox details)
- your Weaviate host URL as `VITE_WEAVIATE_HOST_URL` (you can get this in your [Weaviate dashboard](https://console.weaviate.cloud/dashboard) under sandbox details)
5. Import your data and initalize your collections with the following command
```
yarn run import
```
5. Start your Vue.js app with the following command
```
yarn dev
```
6. Search away!!
💫you can tweak the prompt for the generative search by [editing this line of code](https://github.com/malgamves/vue-vector-search-demo/blob/fcaad1645cfe9d25b00d64f676188b0a05d23a8d/src/views/HomeView.vue#L52)
## 📚 Resources
Learn more about Weaviate applications
- [Weaviate Generative Search](https://weaviate.io/developers/weaviate/modules/reader-generator-modules/generative-openai)
- [Vector Search](https://weaviate.io/developers/weaviate/search/similarity)
## 🤷🏾♂️ Troubleshooting
- Check out the [Weaviate Docs](https://weaviate.io/developers/weaviate)
- Open an [Issue](https://github.com/malgamves/vue-vector-search-demo/issues/new)