diff --git a/README.md b/README.md index 7a9be0ec78..fc415e593b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# anticrm -Anticrm Platform +# Anticrm Platform + +Anticrm Platform is a framework that help building business applications (such as CRM fast). Current exemplary applications include Chat, Task Management, and Applicant Tracking System. + +## Installation + +You need Micrisoft'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. + +## Run in development mode + +``` +cd dev/prod +rushx dev +``` +Then go to http://localhost:8080/login:component:LoginApp and use following credentials to login into the system: + +* login: rosamund@hc.engineering +* pass: 1111 +* workspace: trx40