mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
Readme updates
This commit is contained in:
49
README.md
49
README.md
@@ -1,10 +1,57 @@
|
|||||||
# ALFRESCO WEB COMPONENTS
|
# ALFRESCO WEB COMPONENTS
|
||||||
|
|
||||||
### Running demo project
|
### Configuring development environment
|
||||||
|
|
||||||
|
Get a copy
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/Alfresco/dev-platform-webcomponents.git
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
### Building and running
|
||||||
|
|
||||||
|
**Install dependencies:**
|
||||||
|
|
||||||
|
|
||||||
|
```sh
|
||||||
cd dev-platform-webcomponents/demo-shell-ng2/
|
cd dev-platform-webcomponents/demo-shell-ng2/
|
||||||
npm install
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
**Build and watch with Gulp:**
|
||||||
|
|
||||||
|
```sh
|
||||||
npm run build.dev
|
npm run build.dev
|
||||||
```
|
```
|
||||||
|
|
||||||
|
*or*
|
||||||
|
|
||||||
|
```sh
|
||||||
|
gulp dev
|
||||||
|
```
|
||||||
|
|
||||||
|
**Fast build and watch for dev purposes:**
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
Reference in New Issue
Block a user