From 7f725a703d668831faa85652daabcbaf74df1305 Mon Sep 17 00:00:00 2001 From: Martin Bergljung Date: Tue, 28 Jun 2016 13:38:37 +0100 Subject: [PATCH] Updated Introduction docs, added nodejs version requirements, removed adduser to private repo info --- Introduction.md | 12 +++++++++++- Prerequisites.md | 40 +++++++--------------------------------- 2 files changed, 18 insertions(+), 34 deletions(-) diff --git a/Introduction.md b/Introduction.md index d1f74b233c..085af15cf3 100644 --- a/Introduction.md +++ b/Introduction.md @@ -5,7 +5,17 @@ The framework is provided by Alfresco to make it easy to build custom web applic should manage and view content in the [Alfresco Platform Repository](http://docs.alfresco.com/5.1/concepts/content-repo-about.html) in a custom way. As you probably know, there is a general user interface called [Alfresco Share](http://docs.alfresco.com/5.1/concepts/gs-intro.html) available out-of-the-box. -This framework is to be used when the requirements for the content web client deviates from what is available in the standard general Alfresco Share webapp. +Share is usually used as a quick way of getting started with content management with Alfresco. It gives you access to pretty much all +the features provided by the Alfresco ECM system. And a lot of customers customize it for their specific domain. + +However, there are use-cases that Share does not fit very well, such as: + +- Minimal role based clients, exposing limited functionality based on role +- Clients where the UI layout and style differs significantly from the Share layout and styling +- [Mashup clients](http://whatis.techtarget.com/definition/mash-up) + +This is where this application development framework comes into play, it can be used to create exactly the user interface +(i.e. web client) that the requirements demand. The framework consists of a number of components that can be combined together to form a customized content management application. Here is a list of some of the available web components: diff --git a/Prerequisites.md b/Prerequisites.md index a7bc2b5768..0cdae0cee1 100644 --- a/Prerequisites.md +++ b/Prerequisites.md @@ -80,6 +80,13 @@ Then uncomment filter mappings: If you don't have Node.js installed then access this [page](https://nodejs.org/en/download/) and use the appropriate installer for your OS. +Make sure the Node.js version is > 5: + +``` +$ node -v +v5.12.0 +``` + ## Installing npm The npm package manager is included with Node.js, however it is not usually the latest version as npm is updated more frequently than node.js. @@ -97,36 +104,3 @@ Set up Alfresco's private npm repository as follows: `$ npm set registry http://devproducts.alfresco.me:4873` -### Add a user to the private npm registry (OPTIONAL) - -Note. This step is not needed if you are just going to use (i.e. read) the components. - -You can add yourself as a user to the private npm repository so you can publish to it. -The user needs to have been registered with the repository beforehand. - -Example: - -``` -$ npm adduser --registry http://devproducts.alfresco.me:4873 -Username: -Password: -Email: (this IS public) -``` - -#### How to publish on it: - -Add the repository to your *package.json* file: - -```json - "publishConfig": { - "registry": "http://devproducts.alfresco.me:4873/" - } -``` -*ATTENTION*: If you don't add these lines, then the package is published to the public npm repository. - -Then run the command below each time you want to publish a new version of a component: - -```sh -npm version patch -npm publish -```