How many lines of code do you need to build your first Nextcloud app?

Get Nextcloud up and running

If you haven't done it already...

• How to in the website

Quick and dirt steps:

• Download it from the website or github

• If you are using git clone to get Nextcloud you also need to run:

  • git submodule init &&
  • git submodule update

  (see this link)

• 'cd' into the folder

• Execute 'php -S localhost:8080'

What is an app in Nextcloud

An application that adds extra functionality. For example Contacts, Calendar...

Create the skeleton

• Go to apps.nextcloud.com
• Menu 'App Developer'
• Click on 'Generate app'
• Fill up the form
• Download the skeleton

Add your app to Nextcloud

• Copy the skeleton to the 'apps' folder in your Nextcloud
• Access Nextcloud in the browser
• On your avatar menu
• Click on '+ Apps'
• Your app will be listed in 'Disabled apps'

App skeleton

• appinfo/: app metadata and configuration
• css/: the CSS
• js/: JavaScript files
• lib/: PHP class files (Controller)
• templates/: the templates (View)
• tests/: the tests

The API

The most up to date code and documentation you will find on Github:

• Nextcloud API: All the folders and files under lib/public

• OCP\IPreview: e.g. to get an image preview/thumbnail

• OCP\Files\IRootFolder: e.g. to get the path to a file

• The Gallery app API: e.g. to create thumbnails, crop

• HTTP: e.g. format the response to a request

Links

• Generate App
• Developer Manual
• Security Guidelines
• Coding Style Guidelines
• Nextcloud API