npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@oramacloud/plugin-strapi

v1.1.2

Published

A Strapi plugin to integrate Orama Cloud's search and answers engine, providing seamless search capabilities within your Strapi application.

Downloads

110

Readme

Orama Cloud plugin for Strapi

Build

Introduction

This Strapi plugin integrates Orama Cloud's search and answers engine into your Strapi application, providing seamless search capabilities.

Installation (via package manager)

npm

   npm install @oramacloud/strapi-plugin

yarn

   yarn add @oramacloud/strapi-plugin

pnpm

   pnpm add @oramacloud/strapi-plugin

Installation (via Strapi Marketplace)

  1. Go to your Strapi administration dashboard.
  2. Navigate to the Marketplace section.
  3. Search for Orama Cloud and install the plugin.

Configuration

Configure the plugin in the config/plugins.js file:

// config/plugins.js

module.exports = ({ env }) => ({
  "orama-cloud": {
    config: {
      privateApiKey: env('ORAMA_PRIVATE_API_KEY'),
    },
  },
});

Your ORAMA_PRIVATE_API_KEY will be automatically generated when you create the index. You can also generate a new Private API Key in Developer tools page on Orama Cloud.

Usage

Configure and manage Collections that map your Strapi app Content-Types with an Index on Orama Cloud.

Check out the documentation: Connect to Strapi

Creating an index

  • Visit Orama Cloud and Create a new index with data source "Strapi".
  • Once your index is ready, copy your Private API Key and configure it in your app's config/plugins.js configuration file.
  • Copy the indexId and visit your Strapi administration dashboard to configure your first collection.

Managing collections

Collections map your Content-Types on Strapi with an index on Orama Cloud. To keep your index in sync with the data, you can configure the update settings for each collection.

  • Select Orama Cloud from your Strapi admin menu to manage your collections.
  • Add a new collection.
  • Paste your newly created indexId.
  • Select a Content Type.
  • (Optional) Specify the related records to include.
  • Configure your document schema and your searchable properties.
  • Select the Update Settings option:
    • Live updates will update your index as soon as any content is created, updated or deleted.
    • Scheduled job will automatically update your index at a defined frequency: every 30 minutes, hourly, daily, weekly or monthly.

When an index is not in sync with the latest changes in Strapi, the collection status is set to outdated. When the Scheduled job is executed, it checks the collection status, to avoid triggering an update if the data is already in sync. You can always trigger a new deployment manually.