Back to Platform

Huly Core

foundations/core/README.md

0.7.4135.3 KB
Original Source

Huly Core

⭐️ Your star shines on us. Star us on GitHub!

About

Huly Core is a collection of core packages extracted from the Huly Platform. This repository contains fundamental building blocks and libraries that power the Huly ecosystem, including core data models, client libraries, text processing engines, and platform utilities.

These packages are designed to be reusable, modular, and framework-agnostic, making them suitable for building custom applications on top of the Huly Platform or integrating Huly functionality into existing projects.

Packages

This repository includes the following core packages:

Core Packages

Client Libraries

Text Processing

Utilities

Pre-requisites

Before proceeding, ensure that your system meets the following requirements:

  • Node.js (v20.11.0 or higher is required)
  • Rush - Microsoft's scalable monorepo manager

Installation

You need Microsoft's rush to install the application.

  1. Install Rush globally using the command:
bash
npm install -g @microsoft/rush
  1. Navigate to the repository root and run the following commands:
bash
rush install
rush build

Build

To build all packages:

bash
rush build

To rebuild (ignoring cache):

bash
rush rebuild

Build & Watch

For development purposes, rush build:watch action could be used:

bash
rush build:watch

It includes build and validate phases in watch mode.

Update project structure

If the project's structure is updated, it may be necessary to relink and rebuild the projects:

bash
rush update
rush build

Troubleshooting

If a build fails, but the code is correct, try to delete the build cache and retry:

bash
rm -rf common/temp/build-cache
rush rebuild

Tests

To execute all tests:

bash
rush test

For individual test execution inside a package directory:

bash
rushx test

Package Publishing

To bump a package version:

bash
node ./common/scripts/bump.js -p projectName

API Client Usage

If you want to interact with Huly programmatically, check out the API Client documentation. The API client provides a typed interface for all Huly operations and can be used to build integrations and custom applications.

You can find API usage examples in the Huly examples repository.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

Licensed under the EPL-2.0 license.


© 2025 Hardcore Engineering Inc.