⭐️ Your star shines on us. Star us on GitHub!
The Huly Platform is a robust framework designed to accelerate the development of business applications, such as CRM systems. This repository includes several applications, such as Chat, Project Management, CRM, HRM, and ATS. Various teams are building products on top of the Platform, including Huly and TraceX.
If you're primarily interested in self-hosting Huly without the intention to modify or contribute to its development, please use huly-selfhost. This project offers a convenient method to host Huly using docker, designed for ease of use and quick setup. Explore this option to effortlessly enjoy Huly on your own server.
If you want to interact with Huly programmatically, check out our 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.
To verify the installation, perform the following checks in your terminal:
docker commands are available:docker --version docker compose version
The main branch is the default branch used for production deployments. Changes to this branch are made from the staging branch once a version is ready for community use.
The staging branch is used for pre-release testing. It is stable enough for testing but not yet ready for production deployment.
The develop branch is used for development and is the default branch for contributions.
We periodically merge develop into staging to perform testing builds. Once we are satisfied with the build quality in our pre-release deployment, we merge changes into main and release a new version to the community.
git submodule init git submodule updateTo update the communication submodule
This project uses GitHub Packages for dependency management. To successfully download dependencies, you need to generate a GitHub personal access token and log in to npm using that token.
Follow these steps:
read:packages)npm login --registry=https://npm.pkg.github.com
When prompted, enter your GitHub username, use the generated token as your password
sh ./scripts/fast-start.sh
You need Microsoft's rush to install the application.
npm install -g @microsoft/rush
Alternatively, you can just execute:
sh ./scripts/presetup-rush.sh
Development environment setup requires Docker to be installed on system.
Support is available for both amd64 and arm64 containers on Linux and macOS.
cd ./dev/ rush build # Will build all the required packages. # rush rebuild # could be used to omit build cache. rush bundle # Will prepare bundles. rush package # Will build all webpack packages. rush validate # Will validate all sources with typescript and generate d.ts files required for ts-node execution. rush svelte-check # Optional. svelte files validation using svelte-check. rush docker:build # Will build Docker containers for all applications in the local Docker environment. rush docker:up # Will set up all the containers
Be aware rush docker:build will automatically execute all required phases like build, bundle, package.
Alternatively, you can just execute:
By default, Docker volumes named dev_db, dev_elastic, and dev_files will be created for the MongoDB, Elasticsearch, and MinIO instances.
Add the following line to your /etc/hosts file
127.0.0.1 huly.local
::1 huly.local
Accessing the URL http://huly.local:8087 will lead you to the app in development mode.
Limitations:
Development mode allows for live reloading and a smoother development process.
cd dev/prod rush validate rushx dev-server
Then go to http://localhost:8080
Select "Sign up" on the right panel and click the "Sign up with password" link at the bottom. Enter the new user's credentials, then proceed to create a workspace for them.
Update project structure and databaseIf the project's structure is updated, it may be necessary to relink and rebuild the projects.
If a build fails, but the code is correct, try to delete the build cache and retry.
# from the project root rm -rf common/temp/build-cache
For development purpose rush build:watch action could be used.
It includes build and validate phases in watch mode.
rush test # To execute all tests rushx test # For individual test execution inside a package directory
cd ./tests rush build rush bundle rush docker:build ## creates test Docker containers and sets up test database ./prepare.sh ## runs UI tests rushx uitest
To execute tests in the development environment, please follow these steps:
cd ./tests ./create-local.sh ## use ./restore-local.sh if you only want to restore the workspace to a predefined initial state for sanity. cd ./sanity rushx dev-uitest # To execute all tests against the development environment. rushx dev-debug -g 'pattern' # To execute tests in debug mode with only the matching test pattern.
node ./common/scripts/bump.js -p projectName
This project is tested with BrowserStack.
This guide describes the nuances of building and running the application from source code located on your NTFS drive, which is accessible from both Windows and WSL.
Ensure you have sufficient disk space available:
If there's insufficient space on your system drive (usually C:\), you can change the virtual disk location in Docker Settings → Resources → Advanced.
Make sure Docker is accessible from WSL:
Windows Git often automatically replaces line endings. Since most build scripts are .sh files, ensure your Windows checkout doesn't break them.
Solution options:
git config --global core.autocrlf falseThis disables auto-replacement for all repositories on your machine.
Some commands in the instructions require elevated privileges when working in WSL. If you're using Ubuntu distribution, prefix commands with sudo:
sudo npm install -g @microsoft/rush
If the source code is located on a Windows NTFS drive, then edit the /etc/wsl.conf file in WSL (e.g., sudo nano /etc/wsl.conf) and add the following content if it doesn't exist:
[automount] enabled = true root = /mnt/ options = "metadata,umask=22,fmask=11" [interop] appendWindowsPath = false
However, we recommend storing the repository on a WSL disk, as this dramatically improves build and maintenance operations.
After these preparations, the build instructions should work without issues.
When starting the application (rush docker:up), some network ports in Windows might be occupied. You can fix port mapping in the \dev\docker-compose.yaml file.
Important: Depending on which port you change, you'll need to:
© 2025 Hardcore Engineering Inc.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4