mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
Quick run script
- quick run shell script (for demo setups) - README updates
This commit is contained in:
40
README.md
40
README.md
@@ -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
|
||||
```
|
||||
|
Reference in New Issue
Block a user