diff --git a/README.md b/README.md index 6b165dec3..d8e014825 100644 --- a/README.md +++ b/README.md @@ -27,16 +27,16 @@ Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protrac ## Running documentation locally -For development purposes you can run and test documentation locally. -This is useful when working in different branches instead of a `master` one. +For development purposes, you can run and test documentation locally. +That is useful when working in different branches instead of a `master` one. -Run the following command once to install the lightweight development server: +Run the following command to install the lightweight development server [wsrv](https://denysvuika.gitlab.io/wsrv/#/): ```sh npm install -g wsrv ``` -Run the following command to serve the documentation folder and open in the default browser: +Now you can use the next command to serve the documentation folder in the browser: ```sh wsrv docs/ -s -l -o diff --git a/docs/README.md b/docs/README.md index 08a6a72fc..18e85ecff 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,10 +3,11 @@ ## Prerequisites - Alfresco Content Services (Community) or Alfresco Content Services 5.2.2 (Enterprise) +- [node.js](https://nodejs.org/en/) 8.9.1 or later ## Building and running locally -Please refer to the [developer docs](https://github.com/Alfresco/alfresco-content-app/blob/master/README.md) to get more details on building and running application on your local machine. +Please refer to the [developer docs](/build) to get more details on building and running application on your local machine. ## Using with Docker diff --git a/docs/build.md b/docs/build.md new file mode 100644 index 000000000..2afeb489b --- /dev/null +++ b/docs/build.md @@ -0,0 +1,49 @@ +# Building from source code + +The Content App is based on [Angular CLI](https://cli.angular.io), and you can use all the commands, generators and blueprints supported by the CLI. + +Use the following commands to clone a copy of the project, install dependencies and run it. + +```sh +git clone https://github.com/Alfresco/alfresco-content-app.git +cd alfresco-content-app +npm install +npm start +``` + +The application run at port 3000 by default, and should automatically open in the default browser once project compilation finishes. + +## Proxy settings + +The Content App provides a proxy configuration for local development server +that allows you to address specific scenarios with CORS and native authentication dialogue. + +You can find settings in the "proxy.conf.js" file in the project root directory. + +<p class="warning"> +The proxy settings get automatically applied every time you run the application with "npm start" script. +You must restart the application every time you change the setting values. +</p> + +## Running documentation locally + +For development purposes, you can run and test documentation locally. +That is useful when working in different branches instead of a `master` one. + +Run the following command to install the lightweight development server [wsrv](https://denysvuika.gitlab.io/wsrv/#/): + +```sh +npm install -g wsrv +``` + +Now you can use the next command to serve the documentation folder in the browser: + +```sh +wsrv docs/ -s -l -o +``` + +The browser page is going to automatically reload upon changes. + +## Running unit tests + +Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). diff --git a/docs/index.html b/docs/index.html index 228ebb46a..4366360a0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -18,6 +18,10 @@ title: 'Home', path: '/' }, + { + title: 'Building', + path: 'build' + }, { title: 'Docker', path: 'docker' @@ -26,6 +30,10 @@ title: 'Guides', type: 'dropdown', items: [ + { + title: 'Building', + path: 'build' + }, { title: 'CORS', path: 'cors'