⭐️ Your star shines on us. Star us on GitHub!
Huly Server is a collection of server-side packages extracted from the Huly Platform. This repository contains backend infrastructure components, storage adapters, and server-side utilities that power the Huly ecosystem.
These packages provide essential server-side functionality including database adapters (MongoDB, PostgreSQL, Elasticsearch), storage providers (MinIO, S3), messaging infrastructure (Kafka), and collaborative editing capabilities. They are designed to be modular, scalable, and production-ready for building robust backend services.
This repository includes the following server packages:
- @hcengineering/server-core - Core server infrastructure, adapters, storage management, and server-side utilities
- @hcengineering/server - Main server implementation and runtime
- @hcengineering/server-client - Server-side client implementation for inter-service communication
- @hcengineering/middleware - Server middleware components and request processing
- @hcengineering/mongo - MongoDB adapter for document storage
- @hcengineering/postgres - PostgreSQL adapter for relational data
- @hcengineering/elastic - Elasticsearch adapter for full-text search and analytics
- @hcengineering/server-storage - Storage abstraction layer and implementations
- @hcengineering/minio - MinIO storage provider for object storage
- @hcengineering/s3 - AWS S3 compatible storage provider
- @hcengineering/datalake - Data lake storage and management
- @hcengineering/hulylake - Huly lake storage and management
- @hcengineering/kafka - Apache Kafka integration for event streaming and messaging
- @hcengineering/collaboration - Real-time collaborative editing infrastructure
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
- Docker - For running development services
- Docker Compose - For orchestrating development environment
To verify the installation, perform the following checks in your terminal:
- Ensure that the
dockercommands are available:
docker --version
docker compose version- Verify Node.js version:
node --versionYou 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 build
To 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 testThe repository includes integration tests that require Docker services:
cd tests
./prepare-tests.sh
rush testTo generate test coverage reports:
# Run tests with coverage
rush test
# Merge coverage reports from all packages
node common/scripts/merge-coverage.js
# Generate HTML coverage report
node common/scripts/generate-coverage-html.js
# View coverage summary
sh common/scripts/show-coverage-summary.shThe coverage report will be available in coverage/html/index.html.
To bump a package version:
node ./common/scripts/bump.js -p projectNameThe repository includes a Docker Compose configuration for development services:
cd tests
docker compose up -dThis will start:
- MongoDB - Document database
- PostgreSQL - Relational database
- Elasticsearch - Search engine
- MinIO - Object storage
- Kafka - Message broker
Create a .env file in the tests directory with the following variables:
MONGO_URL=mongodb://localhost:27017
POSTGRES_URL=postgresql://localhost:5432/huly
ELASTIC_URL=http://localhost:9200
MINIO_ENDPOINT=localhost
MINIO_PORT=9000
KAFKA_BROKERS=localhost:9092- Huly Platform - The main Huly Platform repository
- Huly Core - Core packages and client libraries
- 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.