Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vectara/search-hackernews
Search for Hacker News, by Vectara
https://github.com/vectara/search-hackernews
react search search-engine semantic-search vectara
Last synced: 11 days ago
JSON representation
Search for Hacker News, by Vectara
- Host: GitHub
- URL: https://github.com/vectara/search-hackernews
- Owner: vectara
- License: apache-2.0
- Created: 2024-04-09T13:01:08.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-18T15:59:12.000Z (5 months ago)
- Last Synced: 2024-08-01T23:38:30.793Z (5 months ago)
- Topics: react, search, search-engine, semantic-search, vectara
- Language: TypeScript
- Homepage: https://vectara.com
- Size: 4.86 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Vectara sample code for a Semantic Search UI
This app provides Semantic Search for [Hacker News](https://hackernews.com), powered by [Vectara](https://vectara.com/). It was generated using the [Create-UI code-generator](https://github.com/vectara/create-ui), and updated to the requirements of good search for Hacker News.
## Dependencies
Install [npm and node](https://nodejs.org/en/download).
Install dependencies with:
```
npm install
```
## Configuration
Rename `.env.example` to `.env` or create a new `.env` and replace the configurations.
```
REACT_APP_CORPUS_ID=
REACT_APP_CUSTOMER_ID=
REACT_APP_APP_TITLE=
REACT_APP_API_KEY=
REACT_APP_ENDPOINT=api.vectara.io
REACT_APP_QUESTION=
```
## Running locally
Run the code locally and serve it at `http://localhost:3000/` with:
```
npm run start
```
If you make changes to the source code, the app will automatically reload with your changes.
## Running it with Docker
To run it wit docker execute the following command.
```
bash ./docker/run.sh
```
## Set up your Hacker News data in Vectara
To set up this app to pull data from your Vectara corpus:
1. [Create a free Vectara account](https://console.vectara.com/signup).
2. [Create a corpus and add data to it](https://docs.vectara.com/docs/console-ui/creating-a-corpus).
3. [Create a **QueryService** API key](https://docs.vectara.com/docs/console-ui/manage-api-access#create-an-api-key).
**Pro-tip:** After you create an API key, navigate to your corpus and click on the "Access control" tab. Find your API key on the bottom and select the "Copy all" option to copy your customer ID, corpus ID, and API key. This gives you all the data you need to configure a Create-UI app.
Make sure your `CUSTOMER_ID` and `CORPUS_ID` (in your .env file) point to a Vectara corpus where you have crawled Hacker News stories.
You can use the [vectara-ingest hackernews crawler](https://github.com/vectara/vectara-ingest/blob/main/crawlers/hackernews_crawler.py) for that purpose.
You can see a live demo [here](https://hackernews.demo.vectara.com/)
# Author
👤 **Vectara**
- Website: https://vectara.com
- Twitter: [@vectara](https://twitter.com/vectara)
- GitHub: [@vectara](https://github.com/vectara)
- LinkedIn: [@vectara](https://www.linkedin.com/company/vectara/)
- Discord: [@vectara](https://discord.gg/GFb8gMz6UH)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/vectara/search-hackernews/issues). You can also take a look at the [contributing guide](https://github.com/vectara/vectara-answer/blob/master/CONTRIBUTING.md).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2024 [Vectara](https://github.com/vectara).
This project is [Apache 2.0](https://github.com/vectara/search-hackernews/blob/main/LICENSE) licensed.