Skip to content

A set of UI components to help you integrate Orama on your website or app.

License

Notifications You must be signed in to change notification settings

oramasearch/orama-ui-components

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d5b358c · Aug 1, 2024
Jun 27, 2024
Jul 25, 2024
Jul 31, 2024
Jun 27, 2024
Aug 1, 2024
Jul 23, 2024
Jun 27, 2024
Jun 27, 2024
Jul 10, 2024
Jun 27, 2024
Jul 27, 2024
Jul 23, 2024
Jul 22, 2024
Jul 8, 2024
Jul 22, 2024
Jul 26, 2024
Jul 26, 2024
Jun 27, 2024
Jun 29, 2024

Repository files navigation

Orama UI Components

Table of Contents

  1. Introduction
  2. Getting Started
  3. Components
  4. Contributing

Introduction

Welcome to the Orama UI Components Library! This library provides a set of reusable UI components for easily implementing search functionalities in your web applications.

Getting Started

Installation

To get started with our components, you need to install the library via npm:

npm install @orama/ui-components
# TODO: placeholder

Authentication

Since most of our components require you to have a cloud index already deployed, make sure to:

  1. Sign Up: Go to Our Signup Page and create an account.
  2. Create your first index: You can even create a Demo index to start playing around

Components

Chatbox: Chatbox

Description: This component enables you to swiftly set up an entire Retrieval-Augmented Generation (RAG) system in just under 3 minutes. It leverages the answer engine to enhance content generation.

Usage:

<orama-chat-box index="value"></orama-chat-box>

Contributing

We welcome contributions from the community! Please read our Contributing Guide to learn how you can help improve this project.