update readme (#3809)

Signed-off-by: Timur Bondarenko <tibode495@gmail.com>
This commit is contained in:
Timur Bondarenko 2023-10-09 04:21:51 -07:00 committed by GitHub
parent 3f7dc53656
commit 8805a588bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 64 additions and 1 deletions

View File

@ -3,11 +3,43 @@
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`.
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
@ -23,6 +55,12 @@ rush docker:build # Will build Docker containers for all applications in the l
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.
@ -37,6 +75,13 @@ rushx run-local confirm-email user1 # To allow the creation of additional test w
```
or just:
sh ./scripts/build.sh
```bash
sh ./scripts/create-workspace.sh
```
Accessing the URL http://localhost:8087 will lead you to the app in production mode.
Limitations:

6
scripts/build.sh Normal file
View File

@ -0,0 +1,6 @@
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

View File

@ -0,0 +1,6 @@
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, 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.

3
scripts/fast-start.sh Normal file
View File

@ -0,0 +1,3 @@
sh ./scripts/presetup-rush.sh
sh ./scripts/build.sh
sh ./scripts/create-workspace.sh

3
scripts/presetup-rush.sh Normal file
View File

@ -0,0 +1,3 @@
npm install -g @microsoft/rush
rush install
rush build