You are here

Developer guide

The Developer guide includes extensive guidance and reference materials to aid the developer in creating applications and extensions for Alfresco Community Edition.

There are a number of approaches to developing for Alfresco Community Edition depending on what you want to do. For example, if you are writing a client application, perhaps in Ruby or Python to connect to Alfresco Community Edition either on-premise, or Alfresco Share in the Cloud, then you would most likely use the Alfresco Community Edition REST API. If on the other hand you wanted to write a server-side extension in Java, you would use the Public Java API, or perhaps write a web script using Java, JavaScript and FreeMarker. Generally if you are creating extensions to Alfresco Community Edition you would use the Alfresco SDK. This allows you to work in your IDE of choice, using technologies you already know, such as Java and Maven.

This Developer guide attempts to lay out the various options available to you, so you can use the right approach, depending on what you want to achieve.

You can read the material in this Developer guide sequentially, or the following table with give you some starting points if you want to dive in:

What do you want to do? Documentation
You would like to get an overview of the architecture of Alfresco Community Edition from the developer's perspective Architectural overview
You want to write client applications for Alfresco Community Edition using a REST API Alfresco REST API
You are going to build a Platform Extension. Developing extensions
You are going to build a Platform Integration. Developing integrations
You want to write small extensions to Alfresco Community Edition in JavaScript and FreeMarker Web Scripts
You want to create a custom REST API for Alfresco Community Edition Web scripts
You want to get developing for Alfresco using Maven Alfresco SDK
You would like to know what APIs are available for Alfresco Community Edition, and when you should use them Overview of Alfresco APIs
You would like to know how to package your extensions for distribution Extension packaging
You want to write new services in Java, and need to check what APIs are supported Alfresco Public Java API
You want to configure and customize Alfresco Share Share Extensions
You would like to develop extensions to Alfresco Share Developing Share Extensions
You would like to know about the new UI framework Aikau Aikau
You want to develop applications for iOS. Alfresco Mobile SDK for iOS
You want to develop applications for Android. Alfresco Mobile SDK for Android

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.