hcengineering/platform
1
0
Fork 0
mirror of https://github.com/hcengineering/platform.git synced 2024-12-22 11:01:54 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix: grammatical and stylistic errors (#3552)

Browse Source 
Signed-off-by: Yuri Sidorov <403994+newstler@users.noreply.github.com>
This commit is contained in:
Yuri Sidorov 2023-08-10 17:18:56 +02:00 committed by GitHub
parent 8855f878cb
commit c628a0a0d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -1,7 +1,7 @@
# Anticrm Platform
Anticrm Platform is a framework that help building business applications (such as CRM) fast.
Current exemplary applications include Chat, Issue Management(Tracker), and Applicant Tracking System, Boards, Leads, HR.
Anticrm Platform is a framework that helps in building business applications (such as CRM) fast.
The current exemplary applications include Chat, Issue Management (Tracker), Applicant Tracking System, Boards, Leads, and HR.
## Installation
@ -11,42 +11,42 @@ Install [rush](https://rushjs.io) with `$ npm install -g @microsoft/rush` comman
## Build and run
Development environment setup require Docker to be installed on system.
Development environment setup requires Docker to be installed on system.
Supported both amd64 and armv8(arm64) containers on Linux and Macos.
Support is available for both amd64 and armv8 (arm64) containers on Linux and macOS.
```bash
cd ./dev/
rush build # Will build all required packages.
rush build # Will build all the required packages.
rush bundle # Will prepare bundles.
rush docker:build # Will build docker containers for all applications in local docker environment.
docker-compose up -d --force-recreate # Will setup all containers
rush docker:build # Will build Docker containers for all applications in the local Docker environment.
docker-compose up -d --force-recreate # Will set up all the containers
```
By default docker volumes `dev_db` `dev_elastic` `dev_files` will be created for mongo/elastic/minio instances.
By default, Docker volumes named dev_db, dev_elastic, and dev_files will be created for the MongoDB, Elasticsearch, and MinIO instances.
Before we could start we need to create workspace/account and associate it with workspace.
Before you can begin, you need to create a workspace and an account and associate it with the workspace.
```bash
cd ./tool
rushx run-local create-workspace ws1 -o DevWorkspace # Create workspace
rushx run-local create-account user1 -p 1234 -f John -l Appleseed # Create account
rushx run-local configure sanity-ws --list --enable '*' # Enable all modules, then if they are not yet intended to be used by wide audience.
rushx run-local assign-workspace user1 ws1 # Assign workspace to user
rushx run-local confirm-email user1 # To allow create of more test workspaces.
rushx run-local configure sanity-ws --list --enable '*' # Enable all modules, even if they are not yet intended to be used by a wide audience.
rushx run-local assign-workspace user1 ws1 # Assign workspace to user.
rushx run-local confirm-email user1 # To allow the creation of additional test workspaces.
```
Following URL http://localhost:8087 will lead us to app in production mode.
Accessing the URL http://localhost:8087 will lead you to the app in production mode.
Limitations:
- Location installation do not allow to send emails, so password recovery and notification to email functionality is not working.
- Telegram/Gmail/Content integrations are available only as docker container and they are build from private repository sources, but could be used with platform.
- Location installation does not allow sending emails, so password recovery and notification to email functionalities are not working.
- Integrations with Telegram, Gmail, and other content sources are available only as Docker containers, built from private repository sources. However, these integrations can be used with the platform.
## Run in development mode
Development mode allow to live reload and smooth development process.
Development mode allows for live reloading and a smoother development process.
```bash
cd dev/prod
@ -57,21 +57,21 @@ Then go to http://localhost:8080
## Update project structure and database
If projects structure is updated it might be needed to relink and rebuild projects.
If the project's structure is updated, it may be necessary to relink and rebuild the projects.
```bash
rush update
rush build
```
It also might be required to upgrade running database.
It may also be necessary to upgrade the running database.
```bash
cd ./dev/tool
rushx upgrade
```
In cases when project doesn't build for any logical reason try:
In cases where the project fails to build for any logical reason, try the following steps:
```bash
rush update
@ -95,20 +95,20 @@ cd ./tests
rush build
rush bundle
rush docker:build
## creates test docker containers and setups test database
## creates test Docker containers and sets up test database
./prepare.sh
## runs UI tests
rushx uitest
```
To execute tests in development environment, please do following steps:
To execute tests in the development environment, please follow these steps:
```bash
cd ./tests
./create-local.sh ## use ./restore-local.sh to just restore sanity workspace to predefined initial state.
./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 test matching pattern.
rushx dev-debug -g 'pattern' # To execute tests in debug mode with only the matching test pattern.
```
## Package publishing