ALFRESCO WEB COMPONENTS

Prerequisites

• Alfresco repository with CORS enabled. A Docker-compose file is provided by the demo-shell app.

Private Npm repository configuration

All the distribution packages of our components are stored in our private repository visible only from the internal Alfresco lan:

http://devproducts.alfresco.me:4873

How to configure it:

npm set registry http://devproducts.alfresco.me:4873
npm adduser --registry http://devproducts.alfresco.me:4873

How to publish on it:

• Add the repository to your package.json. ATTENTION: If you don't add the following lines, the package is published on the public Npm repository.

  "publishConfig": {
    "registry": "http://devproducts.alfresco.me:4873/"
  }

• Then run the command below each time you want to publish a new version:

npm version patch
npm publish

Running demo project

Steps below show the quickest way to get demo shell up and running.

Using setup script (recommended)

git clone https://github.com/Alfresco/dev-platform-js-api.git
git clone https://github.com/Alfresco/dev-platform-webcomponents.git
cd dev-platform-webcomponents

• Start the demo and Install all the dependencies (do it the first time)

./start.sh -install

• Start the demo and Install all the dependencies and remove the previous version of the npm package(do it after big changes)

./start.sh -cleanInstall

• Start the demo and update the dependencies

./start.sh -update

• Start the demo

./start.sh

For development environment configuration please refer to project docs.

Components

• Core library
• DataTable
• DocumentList
• Viewer
• Login
• Upload

You can browse all the components at the following address:

http://devproducts.alfresco.me/

Yeoman generators

To speed up the development of your Alfresco Angular 2 application or Alfresco Angular 2 component use one of our Yeoman generators. These generators will create for you a full working project with all the right libraries and tools.

How to build a new Alfresco Angular 2 component

To generate your Alfresco Angular 2 component you can use our Yeoman generator

• Yeoman Generator Angular 2 Alfresco component

How to build a new Alfresco Angular 2 application

To generate your Alfresco Angular 2 application you can use our Yeoman generator

• Yeoman Generator Angular 2 Alfresco application