@eloquent/kg

This package provides knowledge graph functionality for Eloquent applications.

Installation

Since this package is published to GitHub Packages, you'll need to configure npm to use GitHub Packages for the @eloquent scope.

1. Create or edit an .npmrc file in your project root:

@eloquent:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

2. Set your GitHub token as an environment variable:

export GITHUB_TOKEN=your_github_token

3. Install the package:

npm install @eloquent/kg

Usage

import {} from /* components or functions */ "@eloquent/kg";

// Your code here

Development

To build the package locally:

npm run build

Publishing

This package is automatically published to GitHub Packages when changes are pushed to the main branch that affect files in the packages/eloquent/kg directory.

For manual publishing:

1. Make sure you have the correct GitHub token set up
2. Update the version in package.json
3. Run:

cd packages/eloquent/kg
npm run build
npm publish

Monorepo Integration

This package is part of the auto-beam-frontend monorepo. When making changes:

1. The package will be automatically published when changes are pushed to the main branch
2. The package follows the early return pattern in its build process
3. To use this package in other packages within the monorepo, add it as a dependency in the package.json file:

"dependencies": {
  "@eloquent/kg": "*"
}