mirror of
https://github.com/run-llama/llamaindex-docusearcher.git
synced 2026-07-01 21:34:15 -04:00
docs: README and LICENSE; ci: actions
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
name: Build
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "24.4.0"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Build
|
||||
run: npm run build
|
||||
@@ -0,0 +1,26 @@
|
||||
name: Lint
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
name: Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "24.4.0"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Lint
|
||||
run: npm run lint
|
||||
@@ -0,0 +1,35 @@
|
||||
name: GitHub Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v[0-9].[0-9]+.[0-9]+*"
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "24.4.0"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Lint
|
||||
run: npm run lint
|
||||
|
||||
- name: Build
|
||||
run: npm run build
|
||||
|
||||
- name: Create GitHub Release
|
||||
uses: ncipollo/release-action@v1
|
||||
with:
|
||||
generateReleaseNotes: true
|
||||
@@ -0,0 +1,23 @@
|
||||
# .pre-commit-config.yaml
|
||||
repos:
|
||||
# General hooks
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v5.0.0
|
||||
hooks:
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
- id: check-yaml
|
||||
- id: check-case-conflict
|
||||
- id: check-merge-conflict
|
||||
- id: check-json
|
||||
- id: pretty-format-json
|
||||
args: ['--autofix']
|
||||
|
||||
# Additional nextjs checks
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: lint
|
||||
name: npm lint
|
||||
entry: npm run lint
|
||||
language: system
|
||||
pass_filenames: false
|
||||
@@ -0,0 +1,21 @@
|
||||
The MIT License
|
||||
|
||||
Copyright (c) LlamaIndex
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
@@ -1,12 +1,56 @@
|
||||
# LlamaIndex DocuSearcher
|
||||
|
||||
Demo application for searching LlamaIndex, LlamaCloud and LlamaIndex Workflows documentation using vibe-llama MCP.
|
||||
LlamaIndex DocuSearcher is a demo application that allows you to search through LlamaIndex, LlamaCloud and LlamaIndex Workflows documentation leveraring the MCP server provided by [vibe-llama](https://github.com/run-llama/vibe-llama).
|
||||
|
||||
## Pre-requisites
|
||||
|
||||
In order to run this application, you need to install `vibe-llama>=0.4.0`.
|
||||
|
||||
You can do that by running:
|
||||
|
||||
```bash
|
||||
pip install -U vibe-llama
|
||||
```
|
||||
|
||||
Or you can execute `vibe-llama` directly with `uvx`:
|
||||
|
||||
```bash
|
||||
uvx vibe-llama --help
|
||||
```
|
||||
|
||||
In order for LlamaIndex DocuSearcher to work, you need the VibeLlama MCP server to be up and running at `http://127.0.0.1:8000/mcp`. To do so, run:
|
||||
|
||||
```bash
|
||||
# install dependencies
|
||||
npm install
|
||||
# run MCP server
|
||||
vibe-llama starter --mcp
|
||||
# run the app
|
||||
## or, with uvx
|
||||
uvx vibe-llama starter --mcp
|
||||
```
|
||||
|
||||
Once you launched the MCP server, you are all set to start with the installation process for LlamaIndex DocuSearcher.
|
||||
|
||||
## Install and Launch
|
||||
|
||||
You first need to clone this repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/run-llama/llamaindex-docusearcher
|
||||
cd llamaindex-docusearcher
|
||||
```
|
||||
|
||||
And then install all the needed dependencies:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
Once you have all the needed dependencies, you can start the app with:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
```
|
||||
|
||||
You'll find the app at `http://localhost:3000`.
|
||||
|
||||
### License
|
||||
|
||||
This application is provided under a [MIT license](LICENSE).
|
||||
|
||||
+1
-1
@@ -68,7 +68,7 @@ export default function HomePage() {
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="max-w mx-auto p-6 space-y-6 bg-gradient-to-br from-[#FFA6EA] via-[#45DFF8] to-[#BB8DEB]">
|
||||
<div className="max-w min-h-screen mx-auto p-6 space-y-6 bg-gradient-to-br from-[#FFA6EA] via-[#45DFF8] to-[#BB8DEB]">
|
||||
<div className="text-center space-y-2">
|
||||
<h1 className="text-3xl font-bold">LlamaIndex DocuSearcher📝</h1>
|
||||
<p className="text-muted-foreground">
|
||||
|
||||
Reference in New Issue
Block a user