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

Merge pull request #490 from Alfresco/dev-wabson-480

Browse Source 
Improve scripts and script docs (reverted from commit 0bd5603418)
This commit is contained in:
Mario Romano
2016-08-02 12:49:21 +01:00
parent 0bd5603418
commit d9ad2f1bad
8 changed files with 157 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
scripts/README.md
View File

@@ -3,64 +3,42 @@
The Alfresco application development framework comes with a demo project that you can run to get a
feel for what's available.
Start by navigating into the app development framework source folder, and then the script folder:
* Start by navigating into the app development framework source folder, and then the script folder:
```ssh
cd alfresco-ng2-components
cd scripts
```
Start using published components
---
This is recommended if you are running from the `master` branch.
Start the demo-shell app after installing all the dependencies from npm (*Note. do it this way only the first time, and be aware, it will take some time*)
* Start the demo and Install all the dependencies (*Note. do it this way only the first time, and be aware, it will take some time*)
```sh
./start.sh -install
```
Or, if you have previously run `-install` but want to update the dependencies, use `-update`
```sh
./start.sh -update
```
If there are no big changes in the demo-shell since you last started then you can start without `-install` and `-update` to skip fetching packages, which should be much quicker
* Start the demo (*the standard way of starting the demo after first initialization*):
```sh
./start.sh
```
If you get errors when starting which do not go away with `-update` or `-install,` or if you want to test starting the demo shell from a clean environment, then use the `-cleanInstall` option
This will remove previous versions of all packages, before running `npm install` again
* Start the demo, install all the dependencies, and remove the previous version of the npm packages (*Note. do this only after big changes*):
```sh
./start.sh -cleanInstall
```
Start using linked components
---
This is recommended if you are using the `development` branch or a feature branch off `development`
If you want to use your local components use the following script with any of the previous options. It will npm link all the components
in the demo shell before starting up the demo-shell.
For a new environment, use `-install`
* Start the demo and update the dependencies:
```sh
./start-linked.sh -install
./start.sh -update
```
When you are restarting, you can skip `-install`
* If you want to use your local components use the following script with any of the previous option. It will npm link all the components
in the demo shell:
```sh
./start-linked.sh
```
The parameters `-update` and `-cleanInstall` work as described above for `start.sh`
For development environment configuration please refer to [project docs](demo-shell-ng2/README.md).
For development environment configuration please refer to [project docs](demo-shell-ng2/README.md).