mirror of
https://github.com/hcengineering/platform.git
synced 2024-12-24 12:06:57 +03:00
174 lines
4.8 KiB
Markdown
174 lines
4.8 KiB
Markdown
# Anticrm Platform
|
|
|
|
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.
|
|
|
|
- [Pre-requisites](#pre-requisites)
|
|
- [Fast start](#fast-start)
|
|
- [Installation](#installation)
|
|
- [Build and run](#build-and-run)
|
|
- Development mode
|
|
- [Run in development mode](#run-in-development-mode)
|
|
- [Update project structure and database](#update-project-structure-and-database)
|
|
- Tests
|
|
- [Tests](#tests)
|
|
- [Unit tests](#unit-tests)
|
|
- [UI tests](#ui-tests)
|
|
- [Package publishing](#package-publishing)
|
|
|
|
## Pre-requisites
|
|
|
|
- Make sure you have the following installed on your system:
|
|
- [Node.js](https://nodejs.org/en/download/)
|
|
- [Docker](https://docs.docker.com/get-docker/)
|
|
- [Docker Compose](https://docs.docker.com/compose/install/)
|
|
- Make sure what docker and docker-compose commands are available in your terminal (e.g. `docker --version` and `docker-compose --version`).
|
|
- Make sure what docker and docker-compose commands can be executed without sudo (e.g. `docker run hello-world` and `docker-compose --version`).
|
|
|
|
## Fast start
|
|
|
|
```bash
|
|
sh ./scripts/fast-start.sh
|
|
```
|
|
|
|
## Installation
|
|
|
|
You need Microsoft's [rush](https://rushjs.io) to install application.
|
|
|
|
Install [rush](https://rushjs.io) with `$ npm install -g @microsoft/rush` command and run `$ rush install` from the repository root, followed by `$ rush build` or just:
|
|
|
|
```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 armv8 (arm64) containers on Linux and macOS.
|
|
|
|
```bash
|
|
cd ./dev/
|
|
rush build # Will build all the required packages.
|
|
rush bundle # Will prepare bundles.
|
|
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
|
|
```
|
|
|
|
or just:
|
|
|
|
```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.
|
|
|
|
Before you can begin, you need to create a workspace and an account and associate it with the workspace.
|
|
|
|
```bash
|
|
cd ./tool # dev/tool in the repository root
|
|
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 ws1 --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.
|
|
|
|
```
|
|
|
|
or just:
|
|
|
|
```bash
|
|
sh ./scripts/create-workspace.sh
|
|
```
|
|
|
|
Accessing the URL http://localhost:8087 will lead you to the app in production mode.
|
|
|
|
Limitations:
|
|
|
|
- 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 allows for live reloading and a smoother development process.
|
|
|
|
```bash
|
|
cd dev/prod
|
|
rushx dev-server
|
|
```
|
|
|
|
Then go to http://localhost:8080
|
|
|
|
Use the following login credentials:
|
|
```
|
|
Email: user1
|
|
Password: 1234
|
|
Workspace: ws1
|
|
```
|
|
|
|
## 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
|
|
```
|
|
|
|
It may also be necessary to upgrade the running database.
|
|
|
|
```bash
|
|
cd ./dev/tool
|
|
rushx upgrade -f
|
|
```
|
|
|
|
In cases where the project fails to build for any logical reason, try the following steps:
|
|
|
|
```bash
|
|
rush update
|
|
rush build --clean
|
|
```
|
|
|
|
## 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.
|