From 67503f94b48700ea9a1dc025845831446eacc47b Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Fri, 22 Apr 2016 19:56:09 +0100 Subject: [PATCH] Update README.md --- README.md | 67 +++++++++---------------------------------------------- 1 file changed, 10 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 3563e5184f..6178980fce 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # ALFRESCO WEB COMPONENTS +

+ alfresco + angular2 +

+ +## Prerequisites + +- [Alfresco Docker image with CORS support](https://github.com/wabson/alfresco-docker-cors) + ### Running demo project **Note**: *Steps below show the quickest way to get demo shell up and running. @@ -27,60 +36,4 @@ npm install ../ng2-components/ng2-alfresco-login npm run build.dev ``` -### Configuring development environment - -**Get a copy** - -```sh -git clone https://github.com/Alfresco/dev-platform-webcomponents.git -``` - -**Install symlinks for Alfresco components** - -*ng2-alfresco-documentlist component:* - -```sh -cd ng2-components/ng2-alfresco-documentlist -npm link -cd ../../demo-shell-ng -npm link ng2-alfresco-documentlist -``` - -*ng2-alfresco-login component:* - -```sh -cd ng2-components/ng2-alfresco-login -npm link -cd ../../demo-shell-ng -npm link ng2-alfresco-login -``` - -Please refer to [this article](https://docs.npmjs.com/cli/link) for more details on npm link. - -### Building and running - -**Install dependencies:** - - -```sh -cd dev-platform-webcomponents/demo-shell-ng2/ -npm install -``` - -**(Option 1) Fast build and watch for dev purposes:** - -```sh -npm start -``` - -**(Option 2) Build and watch with Gulp:** - -```sh -npm run build.dev -``` - -*or* - -```sh -gulp dev -``` +For development environment configuration please refer to [project docs](demo-shell-ng2/README.md).