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

Signed-off-by: Andrey Sobolev <haiodo@gmail.com>
This commit is contained in:
Andrey Sobolev 2025-02-05 11:07:36 +07:00 committed by GitHub
parent fcdbb48521
commit d16dfb9751
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 29 additions and 21 deletions

View File

@ -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).

View File

@ -20,7 +20,7 @@ This project offers a convenient method to host Huly using `docker`, designed fo
## 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
@ -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>&copy; 2025 <a href="https://hardcoreeng.com">Hardcore Engineering Inc</a>.</sup></sub>