Nextcloud app development

Nextcloud provides a robust platform for creating apps that enhance the functionality of its file-sharing and collaboration ecosystem.
This page provides quick links to:

Tutorials

Nextcloud app development tutorials

Nextcloud provides the possibility to implement apps as part of the core (written in PHP and Vue.js). There is also the possibility to implement apps that run outside the server as micro services written in any programming language of your choice, using AppAPI. First, you will need a development environment.

There are two recommended ways to set up a development environment. If you don’t have much time you can use GitHub Codespaces. If you want a development environment for larger projects, you can setup a local development environment using Docker or deploying the components manually.

Setting up a development environment

See tutorial

Set up a quick development environment with GitHub Codespaces

See tutorial

Develop your first Hello World app

Developing a simple interface-only app

Developing a dashboard widget with Vue.js

Developing an integration with external provider using Smart Picker

Developing a complete app with a navigation bar and database

Adding automated tests to your app

Basic app development troubleshooting

Develop your first ExApp in Python

All app development tutorials

API references

Nextcloud API References

Nextcloud exposes various APIs to interact with its core services. Understanding these APIs and having the documentation on the available endpoints at hand is crucial for app development. Here are some essential API references that you can bookmark for when you need to search for a specific capability in the API:

Nextcloud OCP API

The Nextcloud OCP (OwnCloud PHP) API provides PHP classes and functions for interacting with core functionalities. Find detailed information in the Nextcloud OCP API Documentation.

Nextcloud OCS API

The Nextcloud OCS (Open Collaboration Services) API provides a RESTful api that can be used by external apps and front-end components alike to access various functions within Nextcloud.

OCS API additional infos

Nextcloud WebDAV API

Learn about the Nextcloud WebDAV API, which enables collaborative file and folder manipulation, as well as, calendar and scheduling functions.

Developer documentation

The Nextcloud developer manual is your comprehensive guide to app development. It covers the basics, best practices, and coding guidelines.

Latest developer documentation

Nextcloud Academy

Learn how to develop Nextcloud apps

Hands-on, project-based courses for developers building on Nextcloud. Two tracks, same app – choose your language and architecture.

This course is in beta. Only the beginner tracks are written so far, and content may still change. Found a mistake or something unclear? Open an issue on GitHub – feedback is very welcome.

Start learning

Example Apps

Learning from examples is an effective way to understand app development. Explore existing Nextcloud apps in the Nextcloud App Store to see how they are built.

Nextcloud App Store

Other ways to contribute

Nextcloud and all its apps are fully open source, so you can also contribute to existing software and existing apps on GitHub. If you want to help with reproducing bugs or reviewing PR’s we have a tutorial how to easily set up a test environment. All software is translated by volunteers on Transifex.

Contribute on GitHub

The official Nextcloud GitHub repository hosts the source code of Nextcloud core and apps developed at Nextcloud.

Nextcloud on GitHub

Reproduce bugs

Reproducing bugs and testing PR’s with a test environment

See tutorial

Translate Nextcloud on Transifex

You can help bring Nextcloud closer to people all over the world by helping translate Nextcloud to a language you are fluent in.

Nextcloud on Transifex

Get support from the community

We have various channels where community members help each other with app development. We have a Talk room for developers, a dedicated category in our home user forum for development, and an e-mail newsletter for developers.

Developer meetups