base on Huly — All-in-One Project Management Platform (alternative to Linear, Jira, Slack, Notion, Motion) # Huly Platform [](https://x.com/huly_io)  ⭐️ Your star shines on us. Star us on GitHub! ## About 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](https://huly.io) and [TraceX](https://tracex.co).  ## Self-Hosting If you're primarily interested in self-hosting Huly without the intention to modify or contribute to its development, please use [huly-selfhost](https://github.com/hcengineering/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. ## Activity  ## API Client If you want to interact with Huly programmatically, check out our [API Client](./packages/api-client/README.md) 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](https://github.com/hcengineering/huly-examples) repository. ## Table of Contents - [Huly Platform](#huly-platform) - [About](#about) - [Self-Hosting](#self-hosting) - [Activity](#activity) - [API Client](#api-client) - [Table of Contents](#table-of-contents) - [Pre-requisites](#pre-requisites) - [Verification](#verification) - [Branches \& Contributing](#branches--contributing) - [Setup dev environment](#setup-dev-environment) - [Fast start](#fast-start) - [Installation](#installation) - [Build and run](#build-and-run) - [Run in development mode](#run-in-development-mode) - [Update project structure and database](#update-project-structure-and-database) - [Troubleshooting](#troubleshooting) - [Build \& Watch](#build--watch) - [Tests](#tests) - [Unit tests](#unit-tests) - [UI tests](#ui-tests) - [Package publishing](#package-publishing) - [Additional testing](#additional-testing) - [WSL build guide](#wsl-build-guide) ## Pre-requisites - Before proceeding, ensure that your system meets the following requirements: - [Node.js](https://nodejs.org/en/download/) (v20.11.0 is required) - [Docker](https://docs.docker.com/get-docker/) - [Docker Compose](https://docs.docker.com/compose/install/) ## Verification To verify the installation, perform the following checks in your terminal: - Ensure that the `docker` commands are available: ```bash docker --version docker compose version ``` ## Branches & Contributing - 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. ## Setup dev environment ### To initialise the communication submodule ```bash git submodule init git submodule update ``` ### To update the communication submodule ```bash git submodule update ``` ### Authentication 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: 1. Generate a GitHub Token: - Log in to your GitHub account - Go to **Settings** > **Developer settings** > **Personal access tokens** (https://github.com/settings/personal-access-tokens) - Click **Generate new token** - Select the required scopes (at least `read:packages`) - Generate the token and copy it 2. Authenticate with npm: ```bash npm login --registry=https://npm.pkg.github.com ``` When prompted, enter your GitHub username, use the generated token as your password ## Fast start ```bash sh ./scripts/fast-start.sh ``` ## Installation You need Microsoft's [rush](https://rushjs.io) to install the application. 1. Install Rush globally using the command: ```bash npm install -g @microsoft/rush ``` 2. Navigate to the repository root and run the following commands: ```bash rush install rush build ``` Alternatively, you can just execute: ```bash sh ./scripts/presetup-rush.sh ``` ## Build and run Development environment setup requires Docker to be installed on system. Support is available for both amd64 and arm64 containers on Linux and macOS. ```bash 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: ```bash sh ./scripts/build.sh ``` 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 ```plain 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: - Local installation does not support sending emails, thus disabling functionalities such as password recovery and email notifications. ## Run in development mode Development mode allows for live reloading and a smoother development process. ```bash 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 database 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](https://rushjs.io/pages/maintainer/build_cache/) and retry. ```bash # from the project root rm -rf common/temp/build-cache ``` ## Build & Watch For development purpose `rush build:watch` action could be used. It includes build and validate phases in watch mode. ## Tests ### Unit tests ```bash rush test # To execute all tests rushx test # For individual test execution inside a package directory ``` ### UI tests ```bash 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: ```bash 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. ``` ## Package publishing ```bash node ./common/scripts/bump.js -p projectName ``` ## Additional testing This project is tested with BrowserStack. ## WSL build guide 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. ### Prerequisites #### Disk Space Requirements Ensure you have sufficient disk space available: - A fully deployed local application in clean Docker will consume slightly more than **35 GB** of WSL virtual disk space - The application folder after build (sources + artifacts) will occupy **4.5 GB** If there's insufficient space on your system drive (usually `C:\`), you can change the virtual disk location in Docker Settings → Resources → Advanced. #### Docker WSL Integration Make sure Docker is accessible from WSL: 1. Go to Docker Settings → Resources → Advanced → WSL Integration 2. Select the distribution where you'll be building and running the application 3. Verify integration works by running this command in WSL: ```bash docker run hello-world ``` ### Common Issues and Solutions #### Git Line Endings on Windows Windows Git often automatically replaces line endings. Since most build scripts are `.sh` files, ensure your Windows checkout doesn't break them. **Solution options:** - Checkout from WSL instead of Windows - Configure Git on Windows to disable auto-replacement: ```bash git config --global core.autocrlf false ``` This disables auto-replacement for all repositories on your machine. #### Elevated Privileges in WSL Some commands in the instructions require elevated privileges when working in WSL. If you're using Ubuntu distribution, prefix commands with `sudo`: ```bash sudo npm install -g @microsoft/rush ``` #### WSL Configuration 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: ```ini [automount] enabled = true root = /mnt/ options = "metadata,umask=22,fmask=11" [interop] appendWindowsPath = false ``` ### Running the Application After these preparations, the build instructions should work without issues. #### Port Conflicts 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: 1. Find what's using that port 2. Update the new address in the corresponding service configuration _{^{&copy; 2025 <a href="https://hardcoreeng.com">Hardcore Engineering Inc</a>.}} ", Assign "at most 3 tags" to the expected json: {"id":"7667","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"