From a6c01fc77ad543a1c2d45370e3934f6eea974d86 Mon Sep 17 00:00:00 2001 From: Mario Romano Date: Tue, 28 Jun 2016 11:47:07 +0100 Subject: [PATCH] move script in a separate folder --- README.md | 37 ------------------------------------ scripts/README.md | 36 +++++++++++++++++++++++++++++++++++ start.sh => scripts/start.sh | 2 +- 3 files changed, 37 insertions(+), 38 deletions(-) create mode 100644 scripts/README.md rename start.sh => scripts/start.sh (93%) diff --git a/README.md b/README.md index e89885cd4c..91d7ffcd0a 100644 --- a/README.md +++ b/README.md @@ -30,43 +30,6 @@ See the following [page](Introduction.md) for an introduction to the Alfresco Ap Before you start using this development framework, make sure you have installed all required software and done all the necessary configuration, see this [page](Prerequisites.md). -## Downloading the source code for the framework - -The source code comes in two parts, one for the JavaScript API that wraps the Alfresco REST API, and one part with the -actual application development framework, including the Angular 2 based web components: - -``` -$ git clone https://github.com/Alfresco/alfresco-js-api.git -$ git clone https://github.com/Alfresco/app-dev-framework.git -``` - -## Running a demo project - -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: - -`$ cd app-dev-framework` - -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*) - -`app-dev-framework$ ./start.sh -install` - -Start the demo (*the standard way of starting the demo after first initialization*): - -`app-dev-framework$ ./start.sh` - -Start the demo, install all the dependencies, and remove the previous version of the npm packages (*Note. do this only after big changes*): - -`app-dev-framework$ ./start.sh -cleanInstall` - -Start the demo and update the dependencies: - -`app-dev-framework$ ./start.sh -update` - -For development environment configuration please refer to [project docs](demo-shell-ng2/README.md). - ## Components The following is a list of some of the components that you can use when building your custom Alfresco web client: diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000000..205d7506a4 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,36 @@ +## Running a demo project + +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: + +```ssh + cd app-dev-framework +``` + +* 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 +``` + +* Start the demo (*the standard way of starting the demo after first initialization*): + +```sh +./start.sh +``` + +* 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 the demo and update the dependencies: + +```sh +./start.sh -update +``` + +For development environment configuration please refer to [project docs](demo-shell-ng2/README.md). \ No newline at end of file diff --git a/start.sh b/scripts/start.sh similarity index 93% rename from start.sh rename to scripts/start.sh index 8493ac5858..6f2cf56def 100755 --- a/start.sh +++ b/scripts/start.sh @@ -1,5 +1,5 @@ #!/usr/bin/env bash -cd demo-shell-ng2 +cd ../demo-shell-ng2 #!/bin/sh if [[ $1 = "-install" ]]; then