inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Denys Vuika
2016-04-22 19:56:09 +01:00
parent 2b39e91ee7
commit 67503f94b4
1 changed files with 10 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@@ -1,5 +1,14 @@
# ALFRESCO WEB COMPONENTS
<p align="center">
<img title="alfresco" alt='alfresco' src='assets/alfresco.png' width="280px" height="150px"></img>
<img title="angular2" alt='angular2' src='assets/angular2.png' width="150px" height="150px"></img>
</p>
## 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).