⭐️ Your star shines on us. Star us on GitHub!
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.
This repository includes the following core packages:
- @hcengineering/core - Core data models, types, and fundamental platform abstractions
- @hcengineering/platform - Platform runtime, plugin system, and dependency injection
- @hcengineering/model - Data model definitions and schema management
- @hcengineering/client - Client-side data access and synchronization layer
- @hcengineering/client-resources - Shared client resources and utilities
- @hcengineering/api-client - API client for programmatic access to Huly Platform (WebSocket and REST)
- @hcengineering/account-client - Account management client
- @hcengineering/collaborator-client - Real-time collaboration client
- @hcengineering/hulylake-client - HulyLake data warehouse client
- @hcengineering/analytics - Analytics and tracking
- @hcengineering/analytics-service - Analytics service implementation
- @hcengineering/text - High-level text processing utilities
- @hcengineering/text-core - Core text processing engine
- @hcengineering/text-html - HTML text rendering and parsing
- @hcengineering/text-markdown - Markdown support
- @hcengineering/text-ydoc - Yjs document integration for collaborative editing
- @hcengineering/query - Query language and execution engine
- @hcengineering/storage - Storage abstractions and implementations
- @hcengineering/rank - Ranking and ordering utilities
- @hcengineering/retry - Retry logic and resilience patterns
- @hcengineering/rpc - RPC communication layer
- @hcengineering/token - Token management and authentication utilities
Before proceeding, ensure that your system meets the following requirements:
You need Microsoft's rush to install the application.
- Install Rush globally using the command:
npm install -g @microsoft/rush- Navigate to the repository root and run the following commands:
rush install
rush buildTo build all packages:
rush buildTo rebuild (ignoring cache):
rush rebuildFor development purposes, rush build:watch action could be used:
rush build:watchIt includes build and validate phases in watch mode.
If the project's structure is updated, it may be necessary to relink and rebuild the projects:
rush update
rush buildIf a build fails, but the code is correct, try to delete the build cache and retry:
rm -rf common/temp/build-cache
rush rebuildTo execute all tests:
rush testFor individual test execution inside a package directory:
rushx testTo bump a package version:
node ./common/scripts/bump.js -p projectNameIf 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.
- Huly Platform - The main Huly Platform repository
- Huly Self-Host - Self-hosting solution for Huly
- Huly Examples - API usage examples
Contributions are welcome! Please feel free to submit a Pull Request.
Licensed under the EPL-2.0 license.
© 2025 Hardcore Engineering Inc.