Generate and deploy an ADF App - Generate and deploy an ADF App - You can develop a custom ADF application that adds features, behaviors, and customizations. Using the Yeoman scaffolding tool you can quickly create applications for testing in your development environment. The Yeoman Generator for Alfresco ADF Applications is available for free as an open source project on GitHub. - Alfresco - Alfresco Digital Workspace - Alfresco/Alfresco-Digital-Workspace/6.0/Alfresco-Digital-Workspace/Develop/Deploy-front-end-applications/Generate-and-deploy-an-ADF-App - 6.0 - 6.0

Alfresco Digital Workspace

Platform
Alfresco
Product
Alfresco Digital Workspace
Release
6.0
License
ft:lastPublication
2025-10-15T22:17:23.874000
ft:locale
en-US

You can develop a custom ADF application that adds features, behaviors, and customizations. Using the Yeoman scaffolding tool you can quickly create applications for testing in your development environment. The Yeoman Generator for Alfresco ADF Applications is available for free as an open source project on GitHub.

  • Deploy ACS Enterprise Edition and make sure it's accessible from your browser: http://localhost:8080/alfresco
  • Node.js 18.x
Note: All Angular development is done using the Typescript language.
Generate the app using the following steps:
  1. To ensure you have Yeoman installed, open a command prompt and enter yo --version .
    If this is not already installed, run npm install -g yo.
    Note: If you’re on Linux or MacOS, you might need to run the following commands using sudo.
  2. Install the latest version of the Alfresco Yeoman Generator ADF App:
    npm install -g generator-alfresco-adf-app@latest
  3. Install the Angular CLI:
    npm install -g @angular/cli
    The Angular CLI makes it easy to create components, libraries, and more. You can check the installed version of the Angular CLI by using the ng v command in the terminal.
  4. Generate the application:
    yo alfresco-adf-app
  5. Enter a name, choose Content Services as the application blueprint, and then enter Y to install the dependencies:
    The Yeoman generator creates a new project and installs all dependencies required for your application.
    Note: The Yeoman generator creates a new directory for your project. You must work within this directory.
  6. To configure the application to work with Content Services, open the proxy.conf.js file in a code editor.
  7. Modify "target": "http://localhost:8080" so that it matches your Content Services URL and then save the file.
    You don’t need /alfresco at the end of the target URL. For example, if you've launched Alfresco Content Services using Docker Compose, your Alfresco Content Services repository might be available at http://localhost:8080/alfresco. In this case, your proxy.conf.json file might look like:
    module.exports = {
        "/alfresco": {
        "target": "http://localhost:8080",
        "secure": false,
        "changeOrigin": true
        }
    };
    Note: If you’re running an online trial, the Content Services URL is provided in the welcome email.
    For the online trial, the proxy.conf.json file might look like:
    module.exports = {
        "/alfresco": {
        "target": "https://xyz.trials.alfresco.com",
        "secure": false,
        "changeOrigin": true
        }
    };