Quick run script

- quick run shell script (for demo setups)
- README updates
This commit is contained in:
Denys Vuika
2016-04-22 19:36:53 +01:00
parent 6d6c74505a
commit c4070c6b8a
2 changed files with 40 additions and 7 deletions

View File

@@ -1,5 +1,31 @@
# ALFRESCO WEB COMPONENTS
### Running demo project
**Note**: *Steps below show the quickest way to get demo shell up and running.
For development configuration please refer to* **Configuring development environment**
*section further in this document.*
##### Using setup script (recommended)
```sh
git clone https://github.com/Alfresco/dev-platform-webcomponents.git
./start.sh
```
##### Manual setup
```sh
git clone https://github.com/Alfresco/dev-platform-webcomponents.git
cd dev-platform-webcomponents/demo-shell-ng2
npm install
npm install ../ng2-components/ng2-alfresco-documentlist
npm install ../ng2-components/ng2-alfresco-login
npm run build.dev
```
### Configuring development environment
**Get a copy**
@@ -40,7 +66,13 @@ cd dev-platform-webcomponents/demo-shell-ng2/
npm install
```
**Build and watch with Gulp:**
**(Option 1) Fast build and watch for dev purposes:**
```sh
npm start
```
**(Option 2) Build and watch with Gulp:**
```sh
npm run build.dev
@@ -51,9 +83,3 @@ npm run build.dev
```sh
gulp dev
```
**Fast build and watch for dev purposes:**
```sh
npm start
```