From d16dfb975119cc4aa560ce12c3747056758cdc94 Mon Sep 17 00:00:00 2001 From: Andrey Sobolev Date: Wed, 5 Feb 2025 11:07:36 +0700 Subject: [PATCH] Update branches and Clean PR template (#7919) Signed-off-by: Andrey Sobolev --- .github/pull_request_template.md | 5 ---- README.md | 45 ++++++++++++++++++++------------ 2 files changed, 29 insertions(+), 21 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ca910bee5d..e69de29bb2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +0,0 @@ -**Pull Request Requirements:** - -- Provide a brief description of the changeset. -- Include a screenshots if applicable -- Ensure that the changeset adheres to the [DCO guidelines](https://github.com/apps/dco). diff --git a/README.md b/README.md index 9bfc43adfd..3fb5866445 100644 --- a/README.md +++ b/README.md @@ -7,20 +7,20 @@ ## 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. +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). ![Huly](https://repository-images.githubusercontent.com/392073243/6d27d5cc-38cd-4d88-affe-bb88b393180c) ## 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). +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 -![Alt](https://repobeats.axiom.co/api/embed/c42c99e21691fa60ea61b5cdf11c2e0647621534.svg "Repobeats analytics image") +![Alt](https://repobeats.axiom.co/api/embed/c42c99e21691fa60ea61b5cdf11c2e0647621534.svg 'Repobeats analytics image') ## Table of Content @@ -55,26 +55,47 @@ This project offers a convenient method to host Huly using `docker`, designed fo To verify the installation, perform the following checks in your terminal: - Ensure that the `docker` commands are available: + ```bash docker --version docker compose version + ``` + ## Fast start ```bash sh ./scripts/fast-start.sh ``` +## 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. + ## Installation You need Microsoft's [rush](https://rushjs.io) to install 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 @@ -89,7 +110,7 @@ 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 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. @@ -129,11 +150,11 @@ sh ./scripts/create-workspace.sh Add the following line to your /etc/hosts file -``` +```plain 127.0.0.1 host.docker.internal ``` -Accessing the URL http://host.docker.internal:8087 will lead you to the app in development mode. +Accessing the URL will lead you to the app in development mode. Limitations: @@ -149,7 +170,7 @@ rush validate rushx dev-server ``` -Then go to http://localhost:8080 +Then go to Click on "Login with password" link on the bottom of the right panel and use the following login credentials: @@ -168,13 +189,6 @@ rush update rush build ``` -It may also be necessary to upgrade the running database. - -```bash -cd ./dev/tool -rushx upgrade -f -``` - ## 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. @@ -234,4 +248,3 @@ node ./common/scripts/bump.js -p projectName This project is tested with BrowserStack. © 2025 Hardcore Engineering Inc. -