mirror of
https://github.com/hcengineering/platform.git
synced 2025-03-15 02:23:12 +00:00
Update branches and Clean PR template (#7919)
Some checks are pending
CI / build (push) Waiting to run
CI / svelte-check (push) Blocked by required conditions
CI / formatting (push) Blocked by required conditions
CI / test (push) Blocked by required conditions
CI / uitest (push) Waiting to run
CI / uitest-pg (push) Waiting to run
CI / uitest-qms (push) Waiting to run
CI / docker-build (push) Blocked by required conditions
CI / dist-build (push) Blocked by required conditions
Some checks are pending
CI / build (push) Waiting to run
CI / svelte-check (push) Blocked by required conditions
CI / formatting (push) Blocked by required conditions
CI / test (push) Blocked by required conditions
CI / uitest (push) Waiting to run
CI / uitest-pg (push) Waiting to run
CI / uitest-qms (push) Waiting to run
CI / docker-build (push) Blocked by required conditions
CI / dist-build (push) Blocked by required conditions
Signed-off-by: Andrey Sobolev <haiodo@gmail.com>
This commit is contained in:
parent
fcdbb48521
commit
d16dfb9751
5
.github/pull_request_template.md
vendored
5
.github/pull_request_template.md
vendored
@ -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).
|
45
README.md
45
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).
|
||||
|
||||

|
||||
|
||||
## 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
|
||||
|
||||

|
||||

|
||||
|
||||
## 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 <http://host.docker.internal:8087> 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 <http://localhost:8080>
|
||||
|
||||
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.
|
||||
|
||||
<sub><sup>© 2025 <a href="https://hardcoreeng.com">Hardcore Engineering Inc</a>.</sup></sub>
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user