Configuration Guide

This guide provides an overview of how to configure the @morrigu/core package for use in your React applications. @morrigu/core offers a suite of React hooks for interacting with the Morrigu SaaS product, including feature flagging and prompt management based on environmental settings.

Getting Started

Before you begin, ensure you have node and npm/yarn installed on your machine. This guide assumes you have basic knowledge of React and environment variable management in a development project.

Installation

To use @morrigu/core in your project, install it via npm or yarn:

npm install @morrigu/core

Or, if you're using Yarn:

yarn add @morrigu/core

Configuration

@morrigu/core requires specific environment variables to be set for authentication and API interaction:

• MORRIGU_SECRET_KEY: Your Morrigu application's secret key.
• MORRIGU_CLIENT_ID: The client ID for your Morrigu application.

Setting Environment Variables

Development Environment

For local development, you can set these variables in a .env.local file at the root of your project:

MORRIGU_SECRET_KEY=your_secret_key_here
MORRIGU_CLIENT_ID=your_client_id_here

Make sure to add .env.local to your .gitignore file to prevent secret leakage.

Production Environment

In production, set the environment variables through your hosting provider's dashboard. For example, if you're using Vercel or Netlify, you can add environment variables in the project settings.

Using @morrigu/core

After configuring the environment variables, you can start using @morrigu/core in your React components.

import React from 'react';
import { useFeatureFlag } from '@morrigu/core';
import { usePrompt } from '@morrigu/core';

const MyComponent = () => {
  const [prompt, {completion, reset, stream}] = usePrompt('my-prompt');

  return (

  );
};

export default MyComponent;

License

@morrigu/core is open-source software licensed under the MIT license.

This README provides a basic structure for configuring and getting started with your package. Remember to replace placeholder texts like `your_secret_key_here`, `your_client_id_here`, and repository URLs with actual information relevant to your project.